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

This version

4.5.0

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.5.0.tar.gz (20.1 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.5.0-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-4.5.0.tar.gz
  • Upload date:
  • Size: 20.1 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.5.0.tar.gz
Algorithm Hash digest
SHA256 19fba2135ed0e71c7da7a147cf2f358762823198b6741464afbe064a3d77eb09
MD5 01afd429dd85906e3e222cea12743abf
BLAKE2b-256 1a1499cb32aea52945231d8acb0fec8a9a0a8747c460739f27f0ba4eb23884a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-4.5.0-py3-none-any.whl
  • Upload date:
  • Size: 31.0 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2c415d35ef65d39a7775065a48f9161f59b772ec4c2cfb7a580b7afe6c38713
MD5 cd59d30aa2359458a074d277075692e5
BLAKE2b-256 cd52bc6ec89e3af273ba8ff601406a516455d7104b84b9c4ddab8db7e0168e32

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