[//]: # (TODO: add badges for python versions, black, pylint, flake8, unit tests, integration tests)
# Cryton CLI
Cryton CLI is a command line interface used to interact with [Cryton Core](https://gitlab.ics.muni.cz/cryton/cryton-core) (its API).
Cryton toolset is tested and targeted primarily on **Debian** and **Kali Linux**. Please keep in mind that **only
the latest version is supported** and issues regarding different OS or distributions may **not** be resolved.
For more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/cli/).
## Quick-start
Please keep in mind that [Cryton Core](https://gitlab.ics.muni.cz/cryton/cryton-core) must be running and its REST API must be reachable.
Make sure [Docker](https://docs.docker.com/engine/install/) is installed.
Optionally, check out these Docker [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/).
The following script starts an interactive shell using Docker.
```shell
docker run -it --network host registry.gitlab.ics.muni.cz:443/cryton/cryton-cli
```
Use the following to invoke the app:
```shell
cryton-cli
```
For more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/cli/).
## Contributing
Contributions are welcome. Please **contribute to the [project mirror](https://gitlab.com/cryton-toolset/cryton-cli)** on gitlab.com.
For more information see the [contribution page](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/contribution-guide/).
Raw data
{
"_id": null,
"home_page": "https://gitlab.ics.muni.cz/cryton",
"name": "cryton-cli",
"maintainer": "Ji\u0159\u00ed R\u00e1ja",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "raja@ics.muni.cz",
"keywords": "cryton,cli,client",
"author": "Ivo Nut\u00e1r",
"author_email": "nutar@ics.muni.cz",
"download_url": "https://files.pythonhosted.org/packages/91/a4/e062040ae4403a12bd449132f579e1b0e96c7f7b4c8157b8c75f9793579c/cryton_cli-1.1.0.tar.gz",
"platform": null,
"description": "\n\n[//]: # (TODO: add badges for python versions, black, pylint, flake8, unit tests, integration tests)\n\n# Cryton CLI\nCryton CLI is a command line interface used to interact with [Cryton Core](https://gitlab.ics.muni.cz/cryton/cryton-core) (its API).\n\nCryton toolset is tested and targeted primarily on **Debian** and **Kali Linux**. Please keep in mind that **only \nthe latest version is supported** and issues regarding different OS or distributions may **not** be resolved.\n\nFor more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/cli/).\n\n## Quick-start\nPlease keep in mind that [Cryton Core](https://gitlab.ics.muni.cz/cryton/cryton-core) must be running and its REST API must be reachable.\n\nMake sure [Docker](https://docs.docker.com/engine/install/) is installed.\nOptionally, check out these Docker [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/).\n\nThe following script starts an interactive shell using Docker. \n```shell\ndocker run -it --network host registry.gitlab.ics.muni.cz:443/cryton/cryton-cli\n```\n\nUse the following to invoke the app:\n```shell\ncryton-cli\n```\n\nFor more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/cli/).\n\n## Contributing\nContributions are welcome. Please **contribute to the [project mirror](https://gitlab.com/cryton-toolset/cryton-cli)** on gitlab.com.\nFor more information see the [contribution page](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/contribution-guide/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line interface for Cryton Core",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/",
"Homepage": "https://gitlab.ics.muni.cz/cryton",
"Repository": "https://gitlab.ics.muni.cz/cryton/cryton-cli"
},
"split_keywords": [
"cryton",
"cli",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91b16581c7c5cd0ccfbffcee2019a217212fd0c2ee8aabde87b2766f3bb46992",
"md5": "c45247f022a2b2126b9f5cb5b1e611d2",
"sha256": "a9054968c4ae1a582cfac224992828958c6ad99bb4fa3d772cc8317135f966cf"
},
"downloads": -1,
"filename": "cryton_cli-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c45247f022a2b2126b9f5cb5b1e611d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 25700,
"upload_time": "2023-08-12T16:18:01",
"upload_time_iso_8601": "2023-08-12T16:18:01.495808Z",
"url": "https://files.pythonhosted.org/packages/91/b1/6581c7c5cd0ccfbffcee2019a217212fd0c2ee8aabde87b2766f3bb46992/cryton_cli-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91a4e062040ae4403a12bd449132f579e1b0e96c7f7b4c8157b8c75f9793579c",
"md5": "82494b0aba7cbd8842b9ff820e269452",
"sha256": "a77bd2f7399008987599974f989dede7f7112529d111844985b4c321b68e8b59"
},
"downloads": -1,
"filename": "cryton_cli-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "82494b0aba7cbd8842b9ff820e269452",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 16520,
"upload_time": "2023-08-12T16:18:03",
"upload_time_iso_8601": "2023-08-12T16:18:03.991535Z",
"url": "https://files.pythonhosted.org/packages/91/a4/e062040ae4403a12bd449132f579e1b0e96c7f7b4c8157b8c75f9793579c/cryton_cli-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-12 16:18:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cryton-cli"
}
JSON