kleinkram 0.39.0.dev20250224101309

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

to run unit tests:

pytest -m "not slow"

to run all tests (including e2e and integration tests):

pytest

For the latter you need to have an instance of the backend running locally. See instructions in the root of the repository for this. On top of that these tests require particular files to be present in the cli/data/testing directory. To see the exact files that are required, see cli/testing/backend_fixtures.py.

You also need to make sure to be logged in with the cli with klein login.