CLI reference
Every dagnam command grouped by domain, with what it does and its main flags.
CLI reference The commands the dagnam console script exposes, grouped by domain. PID is a project ID, JOB a training job ID, and ID a deployment or hub model ID unless a row says otherwise. Global flags and output - dagnam -v --version --debug . --debug shows a full traceback on error instead of a short message. - Most read commands accept --json print the full JSON response instead of a concise table and --output PATH save it to a file ; --verbose is a compatibility alias for --json . - Run dagnam -h or dagnam -h for a command's full flag list; this page covers the common ones. Exit codes Code Meaning ---- -------------------------------------------------------------------- 0 Success. 1 Error, printed with Error: , details, Try: hints and a docs link. 2 Usage error bad flags or arguments . 130 Interrupted with Ctrl-C. dagnam training attach exits with its child command's exit code instead of one of these, when a command is given after -- . Sign in and account Command What it does Key flags ------------------------------ --------------------------------------------------------------------------------------------- -------------------------------------- dagnam register Create an account, then try to store a new API key; the key step is refused on the Free plan. --api-url dagnam login Authenticate and store an API key. --api-url , --training-metrics-path dagnam logout Remove the stored API key. dagnam whoami Show the resolved API URL, masked key, and its source. dagnam usage Show your plan and usage against plan limits. --json , --output dagnam config list Print all saved config values key masked . dagnam config get KEY Print one config value. dagnam config set KEY VALUE Set training metrics path . dagnam config unset KEY Unset training metrics path . dagnam version Print the dagnam version, Python version and platform. --json dagnam profile show USERNAME Print a user's public profile. --json , --output See Install /docs/dag-lib/install for the config file and environment variables these commands read. Datasets and cache Command What it does Key flags ------------------------------------ --------------------------------------------- ------------------------------------------- dagnam dataset list List available datasets. --type , --search dagnam dataset versions DATASET ID List a dataset's versions. dagnam dataset info DATASET ID Show dataset metadata. --show-download-url dagnam dataset download DATASET ID Download a dataset to a local directory. --output-dir dagnam dataset preview DATASET ID Preview samples and statistics. --rows , --out dagnam dataset update DATASET ID Update name, description or visibility. --name , --description , --visibility dagnam dataset delete DATASET ID Delete a dataset permanently. --yes dagnam dataset roles DATASET ID Assign per column roles and a task type hint. --set COL=ROLE , --task-type-hint dagnam dataset upload PATH Upload a dataset file. --type , --format , --visibility dagnam dataset import-url URL Start a server side dagnam cache list List datasets in the local cache. dagnam cache clear Remove cached datasets immediately. --dataset-id , --dry-run See Load datasets in Python /docs/dag-lib/datasets for load dataset and the framework converters. Projects Command What it does Key flags ----------------------------------------------- ------------------------------------------- ---------------------------------------- dagnam projects list List your projects. --framework , --search dagnam projects get PID Show details for one project. dagnam projects create Create a new project. --title , --framework , --visibility dagnam projects delete PID Delete a project permanently. dagnam projects duplicate PID Clone an existing project. --title dagnam projects architecture PID Save a diagram and config as a new version. --diagram , --config , --message dagnam projects thumbnail PID Upload or download a project thumbnail. --set , --out dagnam projects update PID Update mutable project fields. --title , --visibility , --tags dagnam projects bulk-delete PIDS Delete multiple projects at once. --yes dagnam projects link-dataset PID DATASET ID Link a dataset to a project. --role dagnam projects unlink-dataset PID DATASET ID Unlink a dataset from a project. dagnam projects versions list PID List a project's architecture versions. dagnam projects versions get PID VID Show one architecture version. dagnam projects versions compare PID A B Compare two architecture versions. dagnam projects versions restore PID VID Restore a project to a prior version. dagnam projects versions delete PID VID Delete one architecture version. dagnam projects versions latest PID Show the current latest version. Code generation Command What it does Key flags ----------------------------- ----------------------------------------- ---------------------------------------- dagnam codegen generate PID Generate model code for a project. --framework , --version-id , --async dagnam codegen preview PID Preview generated code without saving it. --framework , --version-id dagnam codegen validate PID Check that a project can generate code. --framework , --version-id dagnam codegen download PID Download generated code as a ZIP. --framework , --dest Training and checkpoints Command What it does Key flags --------------------------------------- ------------------------------------------------------------------------------------ ----------------------------------------------------------------------------------------------- dagnam training create PID Create a platform training job. --epochs , --batch-size , --learning-rate , --optimizer , --loss-function , --dataset-id dagnam training list List your training jobs. --status , --project-id dagnam training get JOB Show details for one training job. dagnam training cancel JOB Cancel a non-terminal job. dagnam training restart JOB Restart a failed, cancelled or timed out job as a fresh run. dagnam training restore JOB CKPT Start a new job from one of a job's checkpoints, under the same checks as restart . dagnam training estimate Estimate resources for a config, without creating a job. the config flags of create dagnam training allowed-strategies List the distribution strategies your credential allows. dagnam training download-code JOB Download a job's generated training code. --out dagnam training dag JOB Download a job's DAG JSON. --out dagnam training delete JOBS Delete one or more training jobs. dagnam training logs JOB Fetch paginated historical logs. --log-level , --source , --page dagnam training metrics JOB Fetch paginated historical metrics. --metric-type , --epoch-start , --epoch-end dagnam training metrics-summary JOB Fetch aggregate metrics for a job. dagnam training attach JOB -- CMD Upload local metrics for a job, optionally running CMD . --metrics-path , --replay dagnam stream JOB Stream live training events over SSE. --heartbeats , --json dagnam checkpoint list JOB List checkpoints for a job. dagnam checkpoint download JOB CKPT Download a checkpoint default latest . --output-dir The optimizer accepts adam , adamw , sgd , rmsprop or adagrad . See Train on your own hardware /docs/training/own-hardware for training attach and the metrics reporter. Deployments Command What it does Key flags ---------------------------------------------- ------------------------------------------------------------------- -------------------------------- dagnam deployments list List your deployments. --status , --project-id dagnam deployments get ID Show details for one deployment. dagnam deployments deploy-version VERSION ID Deploy a servable model version in one call, printing the key once. --name , --project-id dagnam deployments pause ID Pause a running deployment. dagnam deployments resume ID Resume a paused deployment. dagnam deployments delete ID Delete a deployment permanently. dagnam deployments logs ID Fetch deployment logs. --level , --search , --limit dagnam deployments metrics ID Fetch deployment metrics. --time-range dagnam deployments revisions ID List a deployment's revisions, newest first. --page , --limit dagnam deployments update ID Rename a deployment. --name required There is no create , scale , rollback , retry , collect-metrics , estimate-cost , platforms or validate command: capacity is managed automatically, and deploying a different model version is a new deploy-version call. update changes only the name. See Deployments overview /docs/deployments/overview . Inference Command What it does Key flags ---------------------------- -------------------------------------------- ----------------------------- dagnam inference run ID Send one input to a deployment. --input or --input-file dagnam inference batch ID Send multiple inputs to a deployment. --inputs or --inputs-file dagnam inference health ID Report a deployment's health status. dagnam inference schema ID Show a deployment's input and output schema. dagnam inference stream ID Stream a prediction token by token over SSE. --input , --json run , batch and schema need the deployment's own key, not your personal API key; the CLI has no key flag, so pass it for that one command as DAGNAM API KEY= dagnam inference run ... . health and stream use your personal API key. See Calling a deployment /docs/deployments/inference . Hub and models Command What it does Key flags --------------------------------------------- ----------------------------------------------------- ----------------------------------------------------------------- dagnam hub search Search models on the hub. --search , --task-type , --framework dagnam hub get ID Show details for one hub model. dagnam hub star ID / dagnam hub unstar ID Star or remove a star from a model. dagnam hub fork ID Fork a hub model into your account. dagnam hub featured List featured hub models. dagnam hub trending List trending hub models. --days dagnam hub upload-file ID PATH Upload a file to a hub model you own. dagnam hub publish Create a hub model, upload its files and finalize it. --name , --description , --task-type , --framework , --file dagnam hub update ID Update mutable hub model fields. --name , --visibility , --tags dagnam hub delete ID Delete a hub model you own. --yes dagnam hub versions ID List all versions of a hub model. dagnam hub review ID Add a rating and optional review text. --rating , --text dagnam hub starred List models you have starred. dagnam hub use-in-studio ID Import a hub model into Studio as a new project. dagnam models push Push a new model entry, version and artifacts. --name , --slug , --description , --file dagnam models get ID Get a model entry by id. dagnam models list List model entries. --search dagnam models download VERSION ARTIFACT Download one artifact of a version. --output-dir dagnam models lineage VERSION Get a version's lineage graph. dagnam models task-contract KEY VERSION Get a task contract definition. Audit dagnam audit scan , run , status , cancel and delete : scan exported LLM traces locally, then train, serve and score candidate models for the workloads worth replacing. See the dedicated Workload audit /docs/dag-lib/workload-audit page for the full walkthrough of each command. Agent skill Command What it does Key flags ------------------------ ----------------------------------------------------------- ---------------------------------------------------- dagnam agent install Install a skill that teaches a coding agent to use the SDK. --claude , --codex , --all , --symlink , --yes dagnam agent uninstall Remove the installed skill. --claude , --codex , --all , --yes Without a flag, install and uninstall auto detect the harnesses on your machine and prompt before acting; --all targets every one found.
Open in Dagnam.AI docs