kleinkram 0.38.1.dev20250207122632

give me your bags

Kleinkram: CLI

Install the package

pip install kleinkram

Run the CLI

klein

Usage

Here are some basic examples of how to use the CLI.

Listing Files

To list all files in a mission:

klein list -p project-name -m mission-name

Uploading Files

To upload all *.bag files in the current directory to a mission:

klein upload -p project-name -m mission-name *.bag

If you would like to create a new mission on upload use the --create flag.

Downloading Files

To download all files from a mission and save them out:

klein download -p project-name -m mission-name --dest out

You can additionally specify filenames or ids if you only want to download specific files.

Instead of downloading files from a specified mission you can download arbitrary files by specifying their ids:

klein download --dest out *id1* *id2* *id3*

For more information consult the documentation.

Development

Clone the repo

git clone [e-mail]:leggedrobotics/kleinkram.git
cd kleinkram/cli

Setup the environment

virtualenv -ppython3.8 .venv
source .venv/bin/activate
pip install -e . -r requirements.txt

Install pre-commit hooks

pre-commit install

Run the CLI

klein --help

Run Tests

pytest .

or if you want to skip slow tests...

pytest -m "not slow" .