subroutine workspace

The 7 commands under subroutine workspace, each with its arguments and options.

subroutine workspace [OPTIONS] COMMAND [ARGS]...

Look after the spaces work is kept in.

subroutine workspace list

subroutine workspace list [OPTIONS]

Show the workspaces you can reach, by the name you type and what it is called.

Examples:

subroutine workspace list

Options

• --json (flag): Print the list as JSON.

subroutine workspace create

subroutine workspace create [OPTIONS] {slug} {title}

Make another workspace, for work that should be kept apart.

Examples:

subroutine workspace create personal Personal

subroutine workspace create acme "Acme Ltd" --timezone Europe/London

Numbers start again at 1 in a new workspace, so the two do not have to share a sequence — and nothing in one is visible from the other unless you are in both.

Arguments

• slug (str, required): Its short name, used in addresses.
• title (str, required): What to call it.

Options

• --description (str): What it is for.
• --timezone (str): Its zone, e.g. 'Europe/London'. Unset follows the instance.

subroutine workspace rename

subroutine workspace rename [OPTIONS] {slug} {to}

Give a workspace a different short name.

Examples:

subroutine workspace rename si projects

Nothing inside moves — every item keeps its number and everything stays joined to what it was joined to. What stops working is anything that wrote the old name down.

Arguments

• slug (str, required): The workspace to rename, by its short name.
• to (str, required): The new short name.

Options

• --yes (flag): Do not ask.

subroutine workspace update

subroutine workspace update [OPTIONS] {slug}

Change what a workspace is called, what it is for, or which zone its dates are in.

Examples:

subroutine workspace update projects --title Projects

subroutine workspace update acme --timezone Europe/London

The zone is the one that matters: every date in the workspace is read in it, so a workspace set up in the wrong one shows every deadline at the wrong time. Clearing it follows the instance instead.

Its short name is not changed here — that breaks addresses, so it has a command of its own with a warning attached: 'subroutine workspace rename'.

Arguments

• slug (str, required): The workspace, by its short name.

Options

• --title (str, default '\x00not given'): What to call it.
• --description (str, default '\x00not given'): What it is for. Pass '' to clear.
• --timezone (str, default '\x00not given'): Its zone, e.g. 'Europe/London'. Pass '' to follow the instance.
• --colour (str, default '\x00not given'): What its work is marked with, unless a project says otherwise: amber, green, teal, cyan, indigo, violet, magenta, slate. Pass '' to clear.
• --hide-status (str, repeatable): A status not to offer anywhere in it, e.g. 'blocked'. Repeat for more, or pass '' to offer them all.

subroutine workspace settings

subroutine workspace settings [OPTIONS] {slug}

Show what a workspace is configured with, and whether each value was set there.

Examples:

subroutine workspace settings projects

What is set here is what every project in the workspace shows unless it says otherwise. Change one with 'subroutine workspace update'.

Arguments

• slug (str, required): The workspace, by its short name.

Options

• --json (flag): Print the settings as JSON.

subroutine workspace delete

subroutine workspace delete [OPTIONS] {slug}

Put a workspace in the trash, with everything filed in it.

Examples:

subroutine workspace delete acme

Nothing is destroyed: its items keep their numbers and come back exactly as they were with 'subroutine workspace restore'. Its short name is freed, so if something else takes the name in the meantime the restore will ask you to rename that one first.

The only workspace here cannot be deleted — make the one that replaces it first.

Arguments

• slug (str, required): The workspace to delete, by its short name.

Options

• --yes (flag): Do not ask.

subroutine workspace restore

subroutine workspace restore [OPTIONS] {slug}

Take a workspace back out of the trash, and everything in it with it.

Examples:

subroutine workspace restore acme

Arguments

• slug (str, required): The workspace to bring back, by its short name.