Skip to main content

start_command/
usage.rs

1/// Print usage information
2pub fn print_usage() {
3    println!(
4        r#"Usage: start [options] [--] <command> [args...]
5       start <command> [args...]
6       start --status <uuid> [--output-format <format>]
7       start --list [--running] [--output-format <format>]
8       start --upload-log <uuid-or-session-name>
9       start --stop <uuid-or-session-name>
10       start --terminate <uuid-or-session-name>
11       start --attach <uuid-or-session-name> [--read-only]
12       start --resume <uuid-or-session-name> [-- <command>]
13       start --resume-all [--output-format <format>]
14
15Options:
16  --isolated, --isolation, -i <env>  Run in isolated environment (screen, tmux, docker, ssh)
17  --attached, -a        Run in attached mode (foreground)
18  --detached, -d        Run in detached mode (background)
19  --session, -s <name>  Session name for isolation
20  --session-id <uuid>   Session UUID for tracking (auto-generated if not provided)
21  --session-name <uuid> Alias for --session-id
22  --image <image>       Docker image (optional, defaults to OS-matched image)
23  --volume, -v <spec>   Docker bind mount/volume host:container[:mode] (repeatable, docker only)
24  --mount <spec>        Docker --mount spec (repeatable, docker only)
25  --env, -e <KEY=VALUE> Environment variable for docker container (repeatable, docker only)
26  --privileged          Run docker container in privileged mode (docker only)
27  --network <name>      Connect to a named network (repeatable, docker only)
28  --network-alias <alias> Add alias to the first network (repeatable, docker only)
29  --on-kill-resume <N>  Resume a killed (exit 137 / OOM) detached docker session up to N times
30  --recovery-command <cmd>  Command to run in the same container on such a resume
31  --on-kill-resume-delay <min[-max]>  Wait a random number of seconds before each such resume (default 0)
32  --memory <size|N%|MIN%-MAX%>  Docker RAM cap; percentages use daemon capacity
33  --memory-swap <spec>  Combined memory+swap cap (defaults to memory, no extra swap)
34  --cpus <n|N%|MIN%-MAX%>  Docker CPU cap; ranges draw once per creation
35  --on-kill-resume-memory <spec>  New memory cap before a qualifying OOM recovery
36  --cpu-penalty        Enable delayed Docker CPU penalty (default off)
37  --cpu-penalty-cpus <n>  Penalty cap (default 2 CPUs)
38  --cpu-penalty-trigger <p%>  Busy threshold (default 95% of usable CPUs)
39  --cpu-penalty-trigger-window <d>  Fully covered busy window (default 15m)
40  --cpu-penalty-release <p%>  Quiet threshold (default 65% of penalty cap)
41  --cpu-penalty-release-window <d>  Minimum quiet/capped window (default 15m)
42                        Durations accept ms, s, m, h; --status reports penalty state
43  --endpoint <endpoint> SSH endpoint (required for ssh isolation, e.g., user@host)
44  --isolated-user, -u [name]  Create isolated user with same permissions
45  --keep-user           Keep isolated user after command completes
46  --keep-alive, -k      Keep isolation environment alive after command exits
47  --auto-remove-docker-container  Always remove docker container after exit (compatibility alias)
48  --always-cleanup-container  Always remove docker container after exit
49  --keep-container     Keep docker container filesystem after exit
50  --keep-container-on-fail  Remove successful docker containers, keep failed or OOM-killed ones
51  --shell <shell>       Shell to use in isolation environments: auto, bash, zsh, sh (default: auto)
52  --use-command-stream  Use command-stream library for execution (experimental)
53  --status <id>         Show status of execution by UUID or session name (--output-format: links-notation|json|text)
54  --list                List all tracked executions (--output-format: links-notation|json|text)
55  --running             With --list, only report executions that are still running
56  --upload-log <id>     Upload the stored log for an execution UUID or session name
57  --stop <id>           Ask a detached isolated execution to stop gracefully
58  --terminate <id>      Terminate a detached isolated execution immediately
59  --attach <id>         Attach to a running detached isolated execution
60  --read-only           With --attach, follow output without sending input
61  --resume <id>         Restart a stopped detached execution in the same environment
62                        (append -- <command> to run a different command there)
63  --resume-all          Re-attach or reconcile every execution still marked running
64  --cleanup             Clean up stale "executing" records (crashed/killed processes)
65  --cleanup-dry-run     Show stale records that would be cleaned up (without cleaning)
66  --version, -v         Show version information
67
68Examples:
69  start echo "Hello World"
70  start bun test
71  start --isolated tmux -- bun start
72  start -i screen -d bun start
73  start --isolated docker -- echo 'hi'  # uses OS-matched default image
74  start --isolated docker --image oven/bun:latest -- bun install
75  start -i docker -v ~/.config/gh:/root/.config/gh -e TOKEN=abc -- gh repo list
76  start -i docker --image konard/hive-mind-dind:latest --privileged -- solve ...
77  start --isolated ssh --endpoint user@remote.server -- ls -la
78  start --isolated-user -- npm test
79  start -u myuser -- npm start
80  start -i screen --isolated-user -- npm test
81  start --status a1b2c3d4-e5f6-7890-abcd-ef1234567890
82  start --status a1b2c3d4 --output-format json
83  start --list
84  start --list --output-format json
85  start --list --running
86  start --upload-log my-screen-session
87  start --stop my-screen-session
88  start --terminate my-screen-session
89  start --attach my-docker-session
90  start --attach my-docker-session --read-only
91  start --resume my-docker-session
92  start --resume my-docker-session -- bash
93  start --resume-all
94  start -i docker -d --on-kill-resume 3 --recovery-command 'solve --resume' -- solve
95  start -i docker -d --on-kill-resume 3 --on-kill-resume-delay 30-90 -- cargo test
96  start --cleanup-dry-run
97  start --cleanup
98
99Features:
100  - Logs all output to temporary directory
101  - Displays timestamps and exit codes
102  - Auto-reports failures for NPM packages (when gh is available)
103  - Natural language command aliases (via substitutions.lino)
104  - Process isolation via screen, tmux, or docker"#
105    );
106}