AIDC Launch command reference — Docs

Prepare and maintain your computer

CommandWhat it does

aidcx --installInstalls and repairs what AIDC Launch needs; --dry-run previews, --user and --system choose one half

aidcx --uninstallLists what AIDC Launch installed for you; add --force to remove it. Run it as yourself, without sudo

aidcx doctorChecks your computer and, with a project, its workspace settings

aidcx loginSigns you in to MAIT; --check renews and reports the sign-in

aidcx updateUpdates AIDC Launch; needs a MAIT sign-in

aidcx version, aidcx helpPrints the version, or help for a command

Command

aidcx --install

What it does

Installs and repairs what AIDC Launch needs; --dry-run previews, --user and --system choose one half

Command

aidcx --uninstall

What it does

Lists what AIDC Launch installed for you; add --force to remove it. Run it as yourself, without sudo

Command

aidcx doctor

What it does

Checks your computer and, with a project, its workspace settings

Command

aidcx login

What it does

Signs you in to MAIT; --check renews and reports the sign-in

Command

aidcx update

What it does

Updates AIDC Launch; needs a MAIT sign-in

Command

aidcx version, aidcx help

What it does

Prints the version, or help for a command

--install and --uninstall are written as options, with no command word. Uninstall lists anything left to remove by hand.

Set up a project

CommandWhat it does

aidcx scaffoldCreates or updates the project's workspace definition; keep your own copy of a file you edited by hand

aidcx scaffold --dry-runShows what would change

aidcx start --effectiveWrites the settings a start would use, without starting

Command

aidcx scaffold

What it does

Creates or updates the project's workspace definition; keep your own copy of a file you edited by hand

Command

aidcx scaffold --dry-run

What it does

Shows what would change

Command

aidcx start --effective

What it does

Writes the settings a start would use, without starting

scaffold accepts every option from workspace settings. On a terminal it asks which extra access to grant; without a terminal it grants none.

Start a workspace

aidcx start creates, resumes or refreshes the workspace for the project.

OptionWhat it does

--trustedTrusts the project on its first start; later starts do not need it

--rebuildRemoves the workspace and creates it again

--branch <name>Starts a separate checkout and workspace for that branch

--name <name>Starts another named copy on the same branch, sharing its files

--carry-over <paths>Copies ignored files into a new branch checkout, once

--ports offset or ephemeralAvoids port clashes between branch workspaces

--image <image>Uses another image for this start

--frozen-lockfileFails if the project's pinned workspace options changed

Option

--trusted

What it does

Trusts the project on its first start; later starts do not need it

Option

--rebuild

What it does

Removes the workspace and creates it again

Option

--branch <name>

What it does

Starts a separate checkout and workspace for that branch

Option

--name <name>

What it does

Starts another named copy on the same branch, sharing its files

Option

--carry-over <paths>

What it does

Copies ignored files into a new branch checkout, once

Option

--ports offset or ephemeral

What it does

Avoids port clashes between branch workspaces

Option

--image <image>

What it does

Uses another image for this start

Option

--frozen-lockfile

What it does

Fails if the project's pinned workspace options changed

It also accepts every option from workspace settings.

Work inside a workspace

CommandWhat it does

aidcx shellOpens a shell; --root opens it as the administrator

aidcx exec <command>Runs one command and returns its exit code

aidcx cp <from> <to>Copies a file or folder in or out; mark the workspace side with container:

aidcx codeOpens the workspace in VS Code

aidcx stopStops the workspace and keeps it

Command

aidcx shell

What it does

Opens a shell; --root opens it as the administrator

Command

aidcx exec <command>

What it does

Runs one command and returns its exit code

Command

aidcx cp <from> <to>

What it does

Copies a file or folder in or out; mark the workspace side with container:

Command

aidcx code

What it does

Opens the workspace in VS Code

Command

aidcx stop

What it does

Stops the workspace and keeps it

Example: aidcx cp ./report.json container:/tmp/report.json.

See and check workspaces

CommandWhat it does

aidcx listLists the project's workspaces with branch, status, ports and runtime

aidcx inspectShows each setting of a running workspace and where it came from

aidcx healthShows resource use, checks and suggestions

aidcx logsShows the start log saved by aidcx start --debug

aidcx feature <name> statusShows what a listed feature requested and its current state

Command

aidcx list

What it does

Lists the project's workspaces with branch, status, ports and runtime

Command

aidcx inspect

What it does

Shows each setting of a running workspace and where it came from

Command

aidcx health

What it does

Shows resource use, checks and suggestions

Command

aidcx logs

What it does

Shows the start log saved by aidcx start --debug

Command

aidcx feature <name> status

What it does

Shows what a listed feature requested and its current state

Clean up

CommandWhat it does

aidcx deleteRemoves one workspace after asking; --keep-volumes keeps its stored data

aidcx pruneRemoves stopped workspaces and leftover checkouts you tick; never deletes Git branches

aidcx distillSaves a running workspace as a local image after a review

Command

aidcx delete

What it does

Removes one workspace after asking; --keep-volumes keeps its stored data

Command

aidcx prune

What it does

Removes stopped workspaces and leftover checkouts you tick; never deletes Git branches

Command

aidcx distill

What it does

Saves a running workspace as a local image after a review

Projects, devices and display

CommandWhat it does

aidcx workspace add <path> --alias <name>Gives a project a short name; list, info, rename and forget manage names

aidcx feature usb attach --device <id>Attaches a USB device when USB is dynamic

aidcx feature audio attachConnects your speakers or microphone when sound is bridge

aidcx relay statusOn Linux, shows the connection that brings graphical apps and sound to your desktop; restart restarts it

Command

aidcx workspace add <path> --alias <name>

What it does

Gives a project a short name; list, info, rename and forget manage names

Command

aidcx feature usb attach --device <id>

What it does

Attaches a USB device when USB is dynamic

Command

aidcx feature audio attach

What it does

Connects your speakers or microphone when sound is bridge

Command

aidcx relay status

What it does

On Linux, shows the connection that brings graphical apps and sound to your desktop; restart restarts it

Running without prompts

AIDC Launch asks when a real choice comes up. In scripts, answer those choices with options instead:

OptionAnswers

--invalid-lines comment or failWhat to do with broken lines in the workspace definition

--dirty-worktree remove or failWhether to remove a checkout with unsaved or unpushed work

--forceSkips the confirmation of that command

--verbose, --debugPrint more detail

Option

--invalid-lines comment or fail

Answers

What to do with broken lines in the workspace definition

Option

--dirty-worktree remove or fail

Answers

Whether to remove a checkout with unsaved or unpushed work

Option

--force

Answers

Skips the confirmation of that command

Option

--verbose, --debug

Answers

Print more detail

Without a terminal, AIDC Launch stops and names the option it needs instead of choosing for you.