CLI Reference

The ml-dash command logs you in, inspects projects and experiments, and moves experiment data to and from an ML-Dash server. This page covers CLI 0.1.1.

The CLI is a separate program from the Python SDK. Install it with the standalone installer or npm install -g @dreamlake/ml-dash (see Install). pip install ml-dash no longer installs it (since SDK 0.7.0).

Run ml-dash <command> --help for the exact flags of your installed version.

Common options

ml-dash login

ml-dash login [--dash-url URL] [--auth-url URL] [--no-browser]

Starts the device authorization flow. It prints a code, a URL, and a QR code, waits up to 10 minutes for you to approve in a browser, exchanges the result for an ML-Dash token, and stores it. See Authentication for where the token goes and how the SDK reads it.

ml-dash logout

ml-dash logout

Clears the stored token from the keychain and from the ~/.dash/ token files.

ml-dash profile

ml-dash profile [--dash-url URL] [--json] [--cached]

Shows your username, name, email, server URL, token expiry, and whether the data came from the server or the cached token.

ml-dash list

ml-dash list [-p PROJECT] [-n NAMESPACE] [--status STATUS] [--tags TAGS]
             [--detailed] [--tracks] [--topic-filter TOPIC] [--dash-url URL] [-v]

Results come 50 per page. In a terminal, move between pages with n / → / Space / Enter (next) and p / b / ← (previous). Any other key quits. When output is piped, list prints the first page and notes that more results are available.

A glob without a namespace is expanded against your own namespace:

ml-dash list                                   # your projects
ml-dash list -n alice                          # alice's projects
ml-dash list -p my-project                     # experiments in a project
ml-dash list -p 'tom/tes*' --status RUNNING    # glob across projects
ml-dash list --tracks -p tom/test/run-1 --topic-filter 'robot/*'

ml-dash create

ml-dash create -p PROJECT [-d DESCRIPTION] [--dash-url URL]

If the project already exists, create prints a warning and exits successfully.

ml-dash remove

ml-dash remove -p PROJECT [-y] [--dash-url URL]

ml-dash upload

ml-dash upload [PATH] [options]

Uploads experiments that the SDK wrote in local mode. PATH is the local storage directory and defaults to ./.dash.

ml-dash upload                                  # everything in ./.dash
ml-dash upload ./.dash -p 'tom/*/exp*'          # a subset
ml-dash upload --dry-run -v                     # preview
ml-dash upload -t alice/shared-project          # into another project
ml-dash upload --tracks robot_position.jsonl --remote-path tom/proj/exp/robot/position

ml-dash download

ml-dash download [PATH] [options]

Downloads experiments into a local storage directory (PATH, default ./.dash) in the same layout local mode writes.

ml-dash download -p alice/my-project
ml-dash download ./backup -p alice/my-project --experiment exp-one
ml-dash download -p 'alice/tut*' --dry-run
ml-dash download --tracks alice/proj/exp/robot/position -f jsonl -o joints.jsonl

ml-dash api

ml-dash api (--query QUERY | --mutation MUTATION) [--jq PATH] [--dash-url URL]

• A bare body is wrapped for you: me { username } is sent as { me { username } }.
• Single quotes are converted to double quotes, so you can write user(title: 'hello') inside a double-quoted shell string.
• --jq paths start from the response data. There is no top-level data key, so write .me.username, not .data.me.username.

ml-dash api --query "me { username name email }"
ml-dash api --query "me { username }" --jq ".me.username"

ml-dash update

ml-dash update [--check] [--version VERSION] [--json]

Updates through the channel you installed from. An npm install is updated with npm install -g @dreamlake/ml-dash@<version>. A standalone binary downloads the new build, checks its sha256 and size against the release manifest, runs it once, and only then replaces itself. update refuses to downgrade. It also refuses to touch a copy it doesn't own (Homebrew, Nix, pipx, a node_modules tree) and tells you which tool to use instead.

ml-dash version

ml-dash version        # also: ml-dash --version, ml-dash -V

Files and environment variables

Troubleshooting

ml-dash: command not found after upgrading the SDK. Since SDK 0.7.0, pip doesn't install the CLI. Install it as shown in Install. python -m ml_dash.cli no longer exists.

Authentication errors. Run ml-dash profile. It reports an expired token. Then run ml-dash logout && ml-dash login.

The SDK can't find your login but the CLI can. The SDK and the CLI must agree on where the token lives. See Using the token from Python.