Skip to main content

A CLI for interacting with the GAMA platform

Project description

GAMA CLI

GAMA CLI

Publicly available on PyPi 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gama_cli-2.7.2.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

gama_cli-2.7.2-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file gama_cli-2.7.2.tar.gz.

File metadata

  • Download URL: gama_cli-2.7.2.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for gama_cli-2.7.2.tar.gz
Algorithm Hash digest
SHA256 bcc48a3f286e828aaf774f0cbf465136f12d2706deb8e8c478b836ad499b12cb
MD5 7e04c132290a1c795734895fe3ccca3e
BLAKE2b-256 66719f944d48c8ed34f00c5313f38b1c70574aa03f7e518378b9f5d4d97cb9ec

See more details on using hashes here.

File details

Details for the file gama_cli-2.7.2-py3-none-any.whl.

File metadata

  • Download URL: gama_cli-2.7.2-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for gama_cli-2.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8ba42680292d8b4ec39a167644203fc28319799369f282bf069391d9647c80f9
MD5 99209161cf9404393ddb77d4fe559f3e
BLAKE2b-256 dbc7171e2a3602bf2949fd378899507686939cff461cc7876c04559194b2ee16

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page