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

Uploaded Source

Built Distribution

gama_cli-2.4.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-2.4.0.tar.gz
  • Upload date:
  • Size: 14.6 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.4.0.tar.gz
Algorithm Hash digest
SHA256 c7399c787b519616f04b75e96efe845f128a0c8b372b8646289d2630505f837e
MD5 f00e1b4a623cda87316c02af266333ed
BLAKE2b-256 7fc0f5ebc424d2839f2bf2a3cf79d3d28f22eab528fb6f36bc92791e6d2acee3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03c6d526420594837666716fce01c5c876ab36c1ed4f6724a1aa874b1d1e9150
MD5 e50dbb3cb91bd014089a37ac3a3c03a5
BLAKE2b-256 0e2732423234a1cae39f7c7811b226637814a7a56c73934f1360db305d852bd7

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