Pages in Reference

noust setup

Prepare this server, and check that it stayed prepared.

Reference Updated 29 October 2026 View as Markdown

Shell

noust setup [OPTIONS] COMMAND [ARGS]...

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.

noust setup completions

Install tab completion for noust.

Shell

noust setup completions [OPTIONS]

Option	What it does	Default
`-s`, `--shell`	Shell to generate for. Detected from $SHELL when omitted.
`-u`, `--user-only`	Install for the current user instead of system-wide. Needs no root.
`--stdout`	Print the script instead of installing it, to pipe or inspect.
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Diagnose this machine and say how to fix what is wrong.

Shell

noust setup doctor [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Install what deployments need and create Noust's directories.

Shell

noust setup init [OPTIONS]

Option	What it does	Default
`-y`, `--yes`	Take the defaults instead of asking. Use this in provisioning scripts.
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Check that Noust can write to the directories it owns.

Shell

noust setup permissions [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Install Railpack, so container applications can be built without a Dockerfile.

Shell

noust setup railpack [OPTIONS]

Option	What it does	Default
`--force`	Install the pinned release again even when this version is already installed.
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Finish the renaming that 4.0 begins, without restarting anything.

Shell

noust setup rename [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Remove the links an upgrade to 3.0 left under the product's old names.

Shell

noust setup retire-links [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Set up the SSH key Noust clones private repositories with.

Shell

noust setup ssh [OPTIONS]

Option	What it does	Default
`-g`, `--generate`	Create a key if this machine has none.
`-t`, `--type`	Algorithm to generate the key with.	`ed25519`
`-T`, `--test`	Try to connect to a Git host.
`-S`, `--show`	Print the public key to add to your Git host.
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.