Skip to main content

CLI for gear operations

Project description

Gear toolkit CLI


WARNING: The Gear-CLI is actively being developed and is in alpha version. Parts of it may be broken. Please use cautiously. If you notice a broken part, please either create an issue on this repo or email "ATTN: Nate Richman" (CODEOWNER, primary developer)


The gear-cli is currently in alpha version, it can be installed via pip install --pre flywheel-gear-cli

Gear commands

  • gearcli gear build: Build a gear image. Basically a wrapper for docker build which pulls necessary values from the manifest in the specified directory.
  • gearcli gear config: Create/modify gear config.json for running a gear locally.
  • gearcli gear run: Run a gear locally, replaces fw gear run, uses the config.json generated by gear_cli gear config.
  • gearcli gear update-env: Update environment from Docker container into manifest.json.
  • gearcli gear upload: Upload a gear to one or more Flywheel sites.
    • Currently waiting for updated SDK release
  • gearcli gear validate-manifest: Validate manifest.json file in current working directory.

Job commands

  • gearcli job pull: Pull job configuration, assets and build a run script for local testing.

Directory structure

Importing of commands happens in the python-cli commands/ Each command in the gear-cli will live in a separate file named [command_group]_[command].py, within its command group directory

├── job
│   └──
└── gear

Within each file [command_group]_[command].py, there needs to be an add_command() function exposed such as the following:

def add_command(subparsers, parents):
    parser = subparsers.add_parser(
    other arguments

    return parser

def [command](args):

The previous function signatures can be used as a template.


Within the testing folder, for each command there will be unit and integration tests, for example for, the directory will be structured as follows:

| ...
└── cli
    ├── unit_tests
    |   | ...
    |   └──
    └── integration_tests
        | ...

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

flywheel_gear_cli-0.1.0a7-py3-none-any.whl (25.9 kB view hashes)

Uploaded Python 3

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