CLI Reference

The werkr CLI (wer) is the primary interface for managing development environments. It follows a kubectl-inspired pattern with resource-oriented commands.

Usage

wer <command> [flags]

Commands

Command Description
wer apply Apply a configuration from a file
wer bridge Start the interactive terminal UI
wer configure Configure werkr settings
wer copy Copy a resource
wer create Create a resource from command line
wer delete Delete a resource (alias: rm)
wer edit Edit a resource in your default editor
wer export Export a resource to a file
wer get Display one or many resources
wer import Import a resource from an export file
wer patch Update fields of a resource
wer refresh Refresh a workstation's state from the provider
wer restart Restart a workstation
wer shell Open an SSH shell to a workstation
wer start Start a stopped workstation
wer stop Stop a running workstation
wer tmux Connect to a persistent tmux session on a workstation
wer version Print version information
wer wait Wait for a resource to reach a status
wer worker Run the background reconciliation worker

Global Flags

--help, -h    Show help for any command
--version     Print version information

Resource Types

Commands that operate on resources accept the following types:

  • workstation / workstations — Development environments
  • workstationconfig / workstationconfigs — Configuration templates
  • sshkey / sshkeys — SSH key definitions
  • providerconfig / providerconfigs — Provider credentials