OOrchard

CLI Reference

Trowel is the primary CLI for managing Orchard groves. All commands follow the pattern trowel <command> [subcommand] [flags].

Global Flags

FlagShortDescription
--server-sOrchard server URL (overrides config and env var)
--cultivatorCultivator ID (overrides config and env var)
--target-tNamed config target to use (overrides the active target)
--help-hShow help
--version-VShow version

trowel status

Check the connection to the Orchard server:

code
trowel status

Grove Commands

trowel grove plant

Plant a new grove from a git repository:

code
trowel grove plant <repository-url> [flags]
FlagShortDescriptionDefault
--branch-bBranch to check outmain
--name-nGrove name(auto-generated)
--machine-mVM size: small, medium, largesmall
--spec-sEnvironment spec: auto, devcontainer, devfileauto

trowel grove list

List all groves (alias: ls):

code
trowel grove list [flags]
FlagShortDescription
--all-aInclude CLEARED groves

trowel grove show

Show details of a specific grove, including VM and container info:

code
trowel grove show <grove-id>

trowel grove connect

Connect to a grove via SSH (alias: ssh). The grove must be in FLOURISHING state:

code
trowel grove connect <grove-id>

trowel grove clear

Delete a grove:

code
trowel grove clear <grove-id> [flags]
FlagShortDescription
--force-fSkip confirmation prompt

Config Commands

trowel config init

Create a default config file at ~/.orchard/config.toml, or migrate an existing config.properties to TOML:

code
trowel config init

trowel config show

Display current configuration and effective settings:

code
trowel config show

trowel config set

Update values on the active (or a named) target:

code
trowel config set --server http://orchard.example.com:7778
trowel config set --cultivator <your-uuid>
trowel config set --target staging --server https://staging.example.com

trowel config target

Manage named targets:

code
trowel config target list                 # list all targets (* marks the active one)
trowel config target add staging --server https://staging.example.com --cultivator <uuid>
trowel config target set staging           # switch the active target
trowel config target remove staging

See CLI Configuration for the full configuration model.

Dev Server Commands

These commands manage a local Orchard stack using native binaries cached under ~/.orchard/bin/. trowel dev-server start launches two processes:

  • orchard-server (the core API) on the core port — uses an embedded H2 database (~/.orchard/data/orchard), so PostgreSQL is not required.
  • orchard-ui-backend (the Canopy UI) on the UI port — serves the dashboard and reverse-proxies /api/** to the core. The binary is downloaded automatically from the orchard-ui releases and cached at ~/.orchard/bin/orchard-ui-backend.

In dev mode the UI auto-authenticates as the cultivator in your ~/.orchard/config.toml, so no extra setup is needed.

trowel dev-server start

Start the local dev server in the background:

code
trowel dev-server start [flags]
FlagShortDescriptionDefault
--port-pUI (browser) port7777
--core-portOrchard core API port7778
--no-uiStart the core API only, without the Canopy UIfalse
--ui-versionPin a specific orchard-ui-backend releaselatest
--openOpen the UI in your browser once it is readyfalse
--foreground-fRun in foreground instead of backgroundfalse
--verbose-vEnable debug loggingfalse

Open http://localhost:7777 for the Canopy UI; the core API is reachable directly at http://localhost:7778. This core port matches the default server value written by trowel config init.

trowel dev-server stop

Stop the local dev server:

code
trowel dev-server stop

trowel dev-server status

Check the status of the local dev server:

code
trowel dev-server status