Subcommand

refresh

Refreshes the project by updating its components and readying it for development.

Declaration

workspace refresh

Subcommands

all

Performs all configured refreshment tasks.

continuous‐integration

Regenerates the project’s continuous integration configuration files.

examples

Synchronises the project’s compiled examples.

file‐headers

Re‐applies the project file header to each of the project’s files.

git

Regenerates the project’s Git configuration files.

github

Regenerates the project’s GitHub configuration files.

help

Displays usage information.

inherited‐documentation

Synchronises the project’s inherited documentation.

licence

Regenerates the project’s licence file.

read‐me

Regenerates the project’s read‐me file.

resources

Regenerates code providing access to the project’s resources.

scripts

Regenerates the project’s refresh and validation scripts.

Options

•language [language preference]

A language to use instead of the one specified in preferences.

•no‐colour

Removes colour from the output.

•project [path]

The location of the target project if it is not at the current working directory.

•use‐version [version]

Attempts to download and temporarily use the specified version insead of the one which is installed.

Argument Types

[language preference]

A list of IETF language tags or language icons. Semicolons indicate fallback order. Commas indicate that multiple languages should be used. Examples: ‘en-GB’ or ‘🇬🇧EN’ → British English, ‘cy,en;fr’ → both Welsh and English, otherwise French

[path]

A file system path. The form ‘/...’ indicates an absolute path. The form ‘~/...’ indicates a path relative to the home directory. Anything else is interpreted relative to the current working directory.

[version]

A version number or ‘development’.

Linux macOS