Command reference

Tip

You can use the -h or --help flags on any command to see help in the command line.

init

Initialise nusex.

Usage:

nsx init [-h]

build

Build a new template.

Usage:

nsx build [-h] [-o] [-r FROM_REPO] [--ignore-exts IGNORE_EXTS] [--ignore-dirs IGNORE_DIRS] name

Required:

• name: the name for the new template

Optional:

• -o, --overwrite (flag): overwrite an existing template should it already exist

• -c, --check (flag): check the build manifest before building the template

• -r, --from-repo: a repo URL to build a template from

• --ignore-exts: a comma separated list of file types to ignore when scanning for files (default: pyc,pyo,pyd,pyi)

• --ignore-dirs: a comma separated list of directories to ignore when scanning for files (default: .git,.venv,.egg-info,.nox,dist)

Changed in version 0.2.0: Added overwrite flag.

Changed in version 0.3.0: Added ability to build from repo.

Changed in version 0.4.0: Added ability check the build manifest before building.

deploy

Deploy an already existing template.

Usage:

nsx deploy [-h] name

Required:

• name: the name of the template to deploy

list

Display a list of your templates.

Usage:

nsx list [-h] [-f FILTER]

Required:

• -f, --filter: a term to filter your templates by

New in version 0.3.0.

delete

Delete one or more templates.

Usage:

nsx delete [-h] names [names ...]

Required:

• names (strs): the name(s) of the template(s) to delete

New in version 0.2.0.

rename

Rename a template.

Usage:

nsx rename [-h] old_name new_name

Required:

• old_name: the name of the template you want to rename

• new_name: the new name for the template

New in version 0.2.0.

config

Change your user configuration.

Usage:

nsx config [-h] [-v DEFAULT_VERSION] [-d DEFAULT_DESCRIPTION] [-r REPO_USER_URL] [-a AUTHOR] [-e AUTHOR_EMAIL] [-l DEFAULT_LICENSE]

Optional:

• -v, --default-version: the version nusex initialises projects with

• -d, --default-description: the description nusex initialises projects with

• -r, --repo-user-url: your profile URL for your repository manager (for example, your GitHub profile URL)

• -a, --author: your name, or the name you want to use for your projects

• -e, --author-email: your email, or the email of your company/organisation

• -l, --default-license: the license nusex initialises projects with

Note

All optional arguments default to their previous values.

New in version 0.2.0.