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.6.1.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

gama_cli-2.6.1-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-2.6.1.tar.gz
  • Upload date:
  • Size: 15.0 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.6.1.tar.gz
Algorithm Hash digest
SHA256 625ac1304d7ba107a588b3a08a1fc333386c6c3779c2c4bd0ef4f4397217575d
MD5 cabe4b3804f9c8ac5536d09958c23721
BLAKE2b-256 1ea1828211d58d18bb6563b5d46b0d9c42d0a5097cfed3c07051699cd5f80c27

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-2.6.1-py3-none-any.whl
  • Upload date:
  • Size: 23.4 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.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c00d8036cf2396091780cf03982f1067ec1f16735f02210958087875ac9c4d43
MD5 40fd11601db73700c45653fe2050bb3f
BLAKE2b-256 babc505c6c9a6a793dad52a524b3ddaea0c6b6229950c524b4423e5ee5df3ec9

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