# GAMA CLI
Publicly available on [PyPi](https://pypi.org/project/gama-cli/) for convenience but if you don't work at Greenroom Robotics, you probably don't want to use this.
## Install
* For development:
* `pip install -e ./libs/gama_config`
* `pip install -e ./tools/gama_cli`
* For production: `pip install gama-cli`
* You may also need to `export PATH=$PATH:~/.local/bin` if you don't have `~/.local/bin` in your path
* Install autocomplete:
* bash: `echo 'eval "$(_GAMA_CLI_COMPLETE=bash_source gama)"' >> ~/.bashrc`
* zsh: `echo 'eval "$(_GAMA_CLI_COMPLETE=zsh_source gama)"' >> ~/.zshrc` (this is much nicer)
## Usage
* `gama --help` to get help with the CLI
### Groundstation
Installing a GAMA on a groundstation is as simple as this:
* `mkdir ~/gama && cd ~/gama`
* `gama authenticate` to authenticate with the GAMA package registry
* `gama gs configure` to configure GAMA on a groundstation
* `gama gs install` to install GAMA on a groundstation
* `gama gs up` to start GAMA on a groundstation
* `gama gs down` to stop GAMA on a groundstation
### Vessel
Installing a GAMA on a vessel is as simple as this:
* `mkdir ~/gama && cd ~/gama`
* `gama authenticate` to authenticate with the GAMA package registry
* `gama vessel configure` to configure GAMA on a vessel
* `gama vessel install` to install GAMA on a vessel
* `gama vessel up` to start GAMA on a vessel
* `gama vessel down` to stop GAMA on a vessel
## Dev mode
GAMA CLI can be ran in dev mode. This will happen if it is installed with `pip install -e ./tools/gama_cli` or if the environment variable `GAMA_CLI_DEV_MODE` is set to `true`.
Raw data
{
"_id": null,
"home_page": "https://github.com/Greenroom-Robotics/gama",
"name": "gama-cli",
"maintainer": "David Revay",
"docs_url": null,
"requires_python": null,
"maintainer_email": "david.revay@greenroomrobotics.com",
"keywords": "colcon",
"author": "Greenroom Robotics",
"author_email": "team@greenroomrobotics.com",
"download_url": "https://files.pythonhosted.org/packages/36/b3/5138c5fa2076a016761e0011063766c2490fe83dc928a47ad0a8694e6724/gama_cli-2.17.1.tar.gz",
"platform": null,
"description": "# GAMA CLI\n\n\n\nPublicly available on [PyPi](https://pypi.org/project/gama-cli/) for convenience but if you don't work at Greenroom Robotics, you probably don't want to use this.\n\n## Install\n\n* For development:\n * `pip install -e ./libs/gama_config`\n * `pip install -e ./tools/gama_cli`\n* For production: `pip install gama-cli`\n* You may also need to `export PATH=$PATH:~/.local/bin` if you don't have `~/.local/bin` in your path\n* Install autocomplete:\n * bash: `echo 'eval \"$(_GAMA_CLI_COMPLETE=bash_source gama)\"' >> ~/.bashrc`\n * zsh: `echo 'eval \"$(_GAMA_CLI_COMPLETE=zsh_source gama)\"' >> ~/.zshrc` (this is much nicer)\n\n## Usage\n\n* `gama --help` to get help with the CLI\n\n### Groundstation\n\nInstalling a GAMA on a groundstation is as simple as this:\n\n* `mkdir ~/gama && cd ~/gama`\n* `gama authenticate` to authenticate with the GAMA package registry\n* `gama gs configure` to configure GAMA on a groundstation\n* `gama gs install` to install GAMA on a groundstation\n* `gama gs up` to start GAMA on a groundstation\n* `gama gs down` to stop GAMA on a groundstation\n\n### Vessel\n\nInstalling a GAMA on a vessel is as simple as this:\n\n* `mkdir ~/gama && cd ~/gama`\n* `gama authenticate` to authenticate with the GAMA package registry\n* `gama vessel configure` to configure GAMA on a vessel\n* `gama vessel install` to install GAMA on a vessel\n* `gama vessel up` to start GAMA on a vessel\n* `gama vessel down` to stop GAMA on a vessel\n\n## Dev mode\n\nGAMA CLI can be ran in dev mode. This will happen if it is installed with `pip install -e ./tools/gama_cli` or if the environment variable `GAMA_CLI_DEV_MODE` is set to `true`.\n",
"bugtrack_url": null,
"license": "Copyright (C) 2023, Greenroom Robotics",
"summary": "A CLI for interacting with the GAMA platform",
"version": "2.17.1",
"project_urls": {
"Homepage": "https://github.com/Greenroom-Robotics/gama"
},
"split_keywords": [
"colcon"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3df80e811f6efe362391eb333d8ec340e42b1904397cc563409fb54885cc72d",
"md5": "925d10dac2f2f963147659e33606e0f8",
"sha256": "80b41fe80b1e7ca9291539d14eb6ef9a42387e2f0fbf178e154afdef37aa9e91"
},
"downloads": -1,
"filename": "gama_cli-2.17.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "925d10dac2f2f963147659e33606e0f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23719,
"upload_time": "2024-12-17T22:19:10",
"upload_time_iso_8601": "2024-12-17T22:19:10.946422Z",
"url": "https://files.pythonhosted.org/packages/d3/df/80e811f6efe362391eb333d8ec340e42b1904397cc563409fb54885cc72d/gama_cli-2.17.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "36b35138c5fa2076a016761e0011063766c2490fe83dc928a47ad0a8694e6724",
"md5": "cc1772d42003d0f23d7c8b97dd181e39",
"sha256": "20e788474b4c1a61f47b68fbfa46c565893f5c45e248ab0144a88c7dd8d01e90"
},
"downloads": -1,
"filename": "gama_cli-2.17.1.tar.gz",
"has_sig": false,
"md5_digest": "cc1772d42003d0f23d7c8b97dd181e39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15066,
"upload_time": "2024-12-17T22:19:13",
"upload_time_iso_8601": "2024-12-17T22:19:13.217754Z",
"url": "https://files.pythonhosted.org/packages/36/b3/5138c5fa2076a016761e0011063766c2490fe83dc928a47ad0a8694e6724/gama_cli-2.17.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 22:19:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Greenroom-Robotics",
"github_project": "gama",
"github_not_found": true,
"lcname": "gama-cli"
}
JSON
