Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tddschn/nssurge-cli
NSSurge CLI
https://github.com/tddschn/nssurge-cli
cli nssurge surge surge-http-api surge4 surge5
Last synced: 2 months ago
JSON representation
NSSurge CLI
- Host: GitHub
- URL: https://github.com/tddschn/nssurge-cli
- Owner: tddschn
- License: mit
- Created: 2022-05-13T01:59:54.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T16:28:12.000Z (over 1 year ago)
- Last Synced: 2024-11-08T05:33:08.485Z (2 months ago)
- Topics: cli, nssurge, surge, surge-http-api, surge4, surge5
- Language: Python
- Homepage: https://pypi.org/project/nssurge-cli/
- Size: 592 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NSSurge CLI
Command line [Surge HTTP API](https://manual.nssurge.com/others/http-api.html) Client
You can use it to get/set Surge rules / policies / proxy groups, get recent requests / events and much more.
This projects fully implements the [Surge HTTP API spec](https://manual.nssurge.com/others/http-api.html).
- [NSSurge CLI](#nssurge-cli)
- [Installation](#installation)
- [pipx](#pipx)
- [pip](#pip)
- [Usage](#usage)
- [Screenshots](#screenshots)
- [Develop](#develop)
- [See also](#see-also)
## Installation
### pipx
This is the recommended installation method.
```
$ pipx install nssurge-cli
```
### [pip](https://pypi.org/project/nssurge-cli/)
```
$ pip install nssurge-cli
```
## Usage
```
nssurge-cli --help
```
### Screenshots
```
nssurge-cli cap
```
## Develop
```
$ git clone https://github.com/tddschn/nssurge-cli.git
$ cd nssurge-cli
$ poetry install
```
## See also
- [nssurge-api](https://github.com/tddschn/nssurge-api): Python implementation of the [Surge HTTP API spec](https://manual.nssurge.com/others/http-api.html) client using `aiohttp`, used by this project
- [Surge HTTP API spec](https://manual.nssurge.com/others/http-api.html)