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


Release history Release notifications | RSS feed

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gama_cli-4.4.6-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-4.4.6.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for gama_cli-4.4.6.tar.gz
Algorithm Hash digest
SHA256 9646bf11fa559ca004bb5685e820275cda1846e614a57994917ac55d49587fe6
MD5 7c4ccadbf657808badf7b848a46356e8
BLAKE2b-256 c0d2474dcbb1e7826bcb74d94b9729fb5b67bfee6b5329f0bc5a364c60f7e868

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-4.4.6-py3-none-any.whl
  • Upload date:
  • Size: 30.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for gama_cli-4.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9dd383121c617d1d52773ec2a46951c63c0593dac8751011db3b5d88360d7569
MD5 9eb849fb3803ab15751bb656c08e7b28
BLAKE2b-256 35ee0a40ca1af810c516922f5571c03033e90bd63032d15cdd6d40eb2568efdd

See more details on using hashes here.

Supported by

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