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

Uploaded Source

Built Distribution

gama_cli-2.5.0-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-2.5.0.tar.gz
  • Upload date:
  • Size: 14.9 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.5.0.tar.gz
Algorithm Hash digest
SHA256 cb46f2845db79ddcdef8a507bfd8b3610da8cbecfab6349bd794955bf0d93008
MD5 199448cd73e37c04a69b30d339ac514f
BLAKE2b-256 b8e2ed31b9d83474f0e82ad42c8f03ce7c5e505e4ac7b19149bb4d92d804c9aa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 23.3 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecb8ac1a58f122e69b7d9aea32dd530a1d74532277b400229170ea69951b4305
MD5 525db575b0a6dcdd835389a829167b7b
BLAKE2b-256 5291e929d8108c63c6556e708ab277a286dfc2fe8d84f31c1c6300a5a22582d1

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