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.4.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.4-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gama_cli-4.4.4.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.4.tar.gz
Algorithm Hash digest
SHA256 067e466dc731ac358ab15d6cf465630a0f1c28b69ecfcf83113b4e57696a6908
MD5 43f40ac1258bd56af970b9ee4c007928
BLAKE2b-256 611bb5724365462d0724d0009cdb7fd346d50319597523779ef48d6b0226af33

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gama_cli-4.4.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f202b9f8f11eb999d04f1bef7efea2b063bf88fa802bc4028aa18b4cb03c206a
MD5 892f69e1ccbb74b326453c7281d45b91
BLAKE2b-256 1168ad67058c8a8ac693321713901d67f9544e95c82c431545a4280fdeb441b7

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