Command reference

Every command that targets a project takes a number from updock ls. There are no flags to memorize, just numbers.

Command	What it does
updock <name>	Search, pick, configure, and run an app
updock search <name>	Show ranked Docker Hub results only
updock ls	List all projects with live state
updock status <n>	Show details for one project
updock up <n>	Start a project
updock stop <n>	Stop containers, keep data
updock restart <n>	Restart a project
updock rebuild <n>	Rebuild and recreate containers
updock down <n>	Remove containers, keep folder and data
updock logs <n>	Show or follow logs
updock open <n>	Open the mapped port in a browser
updock config <n>	Re-run the configuration prompts
updock rm <n>	Delete a project (asks first)
updock doctor	Run all environment checks
updock version	Print version and build info

Run updock <command> --help for the same information at the terminal.

updock <name>

Search, pick a version, configure, and run an app. This is the main entry point; see Usage for the full pipeline.

updock postgres
updock juice-shop --name ctf-lab    # override the project name

Flags:

• --name <string> - set the project name instead of deriving it from the image.

updock search

Search Docker Hub and print the ranked matches without running anything. Useful for browsing before you commit.

updock search nginx

updock ls

List every project with its number, image, live state, and ports. The number is what you pass to every other command.

updock ls

updock status

Show full details for one project: image, live state, port mappings, environment variables (secrets masked as ••••••), and the project path.

updock status 1

updock up

Start the project. Pulls images if needed and brings the stack up in the background, then prints the URLs you can open.

updock up 1

updock stop

Stop the containers but keep the project and its data. Start it again with updock up <n>.

updock stop 1

updock restart

Restart the containers. Use this to apply changes that only need a fresh start.

updock restart 1

updock rebuild

Rebuild and recreate the containers. Use this after changing the image or configuration.

updock rebuild 1

updock down

Remove the containers but keep the project folder and the data/ directory, so updock up <n> brings everything back.

updock down 1

updock logs

Show the logs for a project. Pass -f to follow them live.

updock logs 1
updock logs 1 -f

Flags:

• -f, --follow - stream new log output as it arrives.

updock open

Open the project's first mapped port in your default browser. Set browser_command in the config to use a specific browser.

updock open 1

updock config

Re-run the configuration prompts for a project. Current values are pre-filled, so press enter to keep them. updock regenerates the .env file and offers to restart so the changes take effect.

updock config 1

updock rm

Delete a project: remove its containers and volumes, then delete the project folder. updock asks for confirmation first unless you pass --yes. This cannot be undone.

updock rm 1
updock rm 1 --yes    # skip the confirmation

Flags:

• -y, --yes - skip the confirmation prompt.

updock doctor

Run all environment checks: Docker installed, Compose available, daemon running, socket accessible. For each failure it prints the problem and the fix. See Troubleshooting.

updock doctor

updock version

Print the version, commit, build date, Go version, and platform.

updock version