Overview

Every desk command at a glance, and the conventions they share.

Usage#

Usage

desk COMMAND [ARGUMENT]

Command	Purpose
`desk new [REPOSITORY]`	Create an empty workspace or a clone, and go there
`desk cd [NAME]`	Go to a workspace
`desk path [NAME]`	Print a workspace's path
`desk list`	Show workspaces; `*` marks the current one
`desk rm [NAME]`	Delete a workspace after confirmation
`desk init SHELL`	Print shell integration for zsh, bash, or fish
`desk version`	Print the version

desk help, desk --help, or desk with no arguments prints a summary.

Conventions#

NAMEname or prefix

A workspace name such as misty-ember, or any prefix that matches only one workspace, such as mis. Leave it out to use the workspace containing your current directory.

REPOSITORYowner/repo, URL, or path

GitHub owner/repo, any Git URL, or a local path that starts with /, ./, or ../.

desk new and desk cd change your directory only with shell integration. Without it, desk new still creates the workspace and prints its path.

Output and Exit Status#

Paths and listings go to standard output. Messages and prompts go to standard error, so cd "$(desk new)" works in scripts. Errors print with a desk: prefix and exit with status 1:

Output

desk: no workspace "nope" (see desk list)