# 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/63/5f/5b7fa073f0b6ad71c7b4c3f532bd0d1fcc103371ef7e9ec8504613c944c6/gama_cli-3.5.0.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": "3.5.0",
"project_urls": {
"Homepage": "https://github.com/Greenroom-Robotics/gama"
},
"split_keywords": [
"colcon"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aac004fbfe520d85288458148a52014f072e161b7c5ecb156353b5ef9d64b03a",
"md5": "df6fd70f0a9633fa0d532a6c2c90ba30",
"sha256": "d58bd984197c1c0bcc2524ec0651739ab42644aafabb81c7e0085405c3a4f5ab"
},
"downloads": -1,
"filename": "gama_cli-3.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df6fd70f0a9633fa0d532a6c2c90ba30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 24129,
"upload_time": "2025-02-23T20:13:54",
"upload_time_iso_8601": "2025-02-23T20:13:54.977759Z",
"url": "https://files.pythonhosted.org/packages/aa/c0/04fbfe520d85288458148a52014f072e161b7c5ecb156353b5ef9d64b03a/gama_cli-3.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "635f5b7fa073f0b6ad71c7b4c3f532bd0d1fcc103371ef7e9ec8504613c944c6",
"md5": "ebbad874db614f12e57d8af005a360c6",
"sha256": "64b11b5c5aa0535e951ed49226314572b97fc4ab41ff7531b94cbc1eda6e3dda"
},
"downloads": -1,
"filename": "gama_cli-3.5.0.tar.gz",
"has_sig": false,
"md5_digest": "ebbad874db614f12e57d8af005a360c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15272,
"upload_time": "2025-02-23T20:13:56",
"upload_time_iso_8601": "2025-02-23T20:13:56.741622Z",
"url": "https://files.pythonhosted.org/packages/63/5f/5b7fa073f0b6ad71c7b4c3f532bd0d1fcc103371ef7e9ec8504613c944c6/gama_cli-3.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 20:13:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Greenroom-Robotics",
"github_project": "gama",
"github_not_found": true,
"lcname": "gama-cli"
}
JSON
