nssurge-cli

Name	nssurge-cli JSON
Version	2.0.11 JSON
	download
home_page	https://github.com/tddschn/nssurge-cli
Summary	NSSurge CLI
upload_time	2023-05-31 14:37:38
maintainer
docs_url	None
author	Xinyuan Chen
requires_python	>=3.11,<4.0
license	MIT
keywords	nssurge cli surge typer
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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/usage.png)

### Screenshots

```
nssurge-cli cap
```
![](./screenshots/cap.png)

## 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)
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tddschn/nssurge-cli",
    "name": "nssurge-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0",
    "maintainer_email": "",
    "keywords": "nssurge,cli,surge,typer",
    "author": "Xinyuan Chen",
    "author_email": "45612704+tddschn@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/1a/3b/2f492a807c4ceeef2a027b26d962acd3c1e8e215577f5ce80071cf61ef39/nssurge_cli-2.0.11.tar.gz",
    "platform": null,
    "description": "# NSSurge CLI\n\nCommand line [Surge HTTP API](https://manual.nssurge.com/others/http-api.html) Client\n\nYou can use it to get/set Surge rules / policies / proxy groups, get recent requests / events and much more. \n\nThis projects fully implements the [Surge HTTP API spec](https://manual.nssurge.com/others/http-api.html).\n\n- [NSSurge CLI](#nssurge-cli)\n  - [Installation](#installation)\n    - [pipx](#pipx)\n    - [pip](#pip)\n  - [Usage](#usage)\n    - [Screenshots](#screenshots)\n  - [Develop](#develop)\n  - [See also](#see-also)\n\n## Installation\n\n### pipx\n\nThis is the recommended installation method.\n\n```\n$ pipx install nssurge-cli\n```\n\n### [pip](https://pypi.org/project/nssurge-cli/)\n\n```\n$ pip install nssurge-cli\n```\n\n## Usage\n\n```\nnssurge-cli --help\n```\n\n![](./screenshots/usage.png)\n\n### Screenshots\n\n```\nnssurge-cli cap\n```\n![](./screenshots/cap.png)\n\n## Develop\n\n```\n$ git clone https://github.com/tddschn/nssurge-cli.git\n$ cd nssurge-cli\n$ poetry install\n```\n\n## See also\n\n- [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\n- [Surge HTTP API spec](https://manual.nssurge.com/others/http-api.html)",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "NSSurge CLI",
    "version": "2.0.11",
    "project_urls": {
        "Bug Tracker": "https://github.com/tddschn/nssurge-cli/issues",
        "Homepage": "https://github.com/tddschn/nssurge-cli",
        "Repository": "https://github.com/tddschn/nssurge-cli"
    },
    "split_keywords": [
        "nssurge",
        "cli",
        "surge",
        "typer"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3d0414e46a2f448b3c992b21f0ac0ad2766991f34f1111ea2ba46eded39278d",
                "md5": "c83eaf9a323ffb11c95ef6c4dc26f616",
                "sha256": "438dae4ad9584a457f902656b2c750d54de226ede4a0ecafc3f1078f16189f22"
            },
            "downloads": -1,
            "filename": "nssurge_cli-2.0.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c83eaf9a323ffb11c95ef6c4dc26f616",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0",
            "size": 19334,
            "upload_time": "2023-05-31T14:37:37",
            "upload_time_iso_8601": "2023-05-31T14:37:37.061042Z",
            "url": "https://files.pythonhosted.org/packages/d3/d0/414e46a2f448b3c992b21f0ac0ad2766991f34f1111ea2ba46eded39278d/nssurge_cli-2.0.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a3b2f492a807c4ceeef2a027b26d962acd3c1e8e215577f5ce80071cf61ef39",
                "md5": "9bb02fa6758382c18ac482fdfddd8df5",
                "sha256": "c43b1ebbc28ffb45c4a7fca0a723c3bfe57af915ad60ef4db6424810fceb267f"
            },
            "downloads": -1,
            "filename": "nssurge_cli-2.0.11.tar.gz",
            "has_sig": false,
            "md5_digest": "9bb02fa6758382c18ac482fdfddd8df5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 11535,
            "upload_time": "2023-05-31T14:37:38",
            "upload_time_iso_8601": "2023-05-31T14:37:38.681410Z",
            "url": "https://files.pythonhosted.org/packages/1a/3b/2f492a807c4ceeef2a027b26d962acd3c1e8e215577f5ce80071cf61ef39/nssurge_cli-2.0.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-31 14:37:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tddschn",
    "github_project": "nssurge-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "nssurge-cli"
}