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

Uploaded Source

Built Distribution

gama_cli-2.7.0-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-2.7.0.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.0.tar.gz
Algorithm Hash digest
SHA256 d5f5f190970a012fd07f4765a3599215a0cacc90f571b382500ae2abc80fa17c
MD5 e2a1470dc7bb0fd31d5cf4794b9a27a6
BLAKE2b-256 6a6f18c2b73dbecfdcf1a8c3b471934b58b18c4d83e96b3c2230af7a7c8fd5c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-2.7.0-py3-none-any.whl
  • Upload date:
  • Size: 23.6 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac92340c9331d6f36cea04818918ec663195dcff6b92744b3673296c797ecb7e
MD5 1b7d73c3e747f1590fed37f86a5cb9ce
BLAKE2b-256 6ee3f8b512ea378322018d59ad504d42c0e63c0651542e2ade43d71e403435de

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