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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-2.4.1.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.4.1.tar.gz
Algorithm Hash digest
SHA256 eaeaab1f3eb7de4d62f5ac3244893270de60bb70b0e53217369aa321d8e39332
MD5 7d74f0f6e459bf35b5a0cc24db940b4a
BLAKE2b-256 b4f9b7dcab5d607a9d5d050dc57a482b38c1a43b153a6a2f431e16832c8337bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-2.4.1-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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 038397c5cd8ed481a72595c323692946e3172bd3d498e0daedf07e89c6c95dbb
MD5 1643c61498466a25e7ef7a0c9320201e
BLAKE2b-256 a3df443bf493b28d9f13cfba4e01380824d29a3d2706d4f3572b383f9ca4e34a

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