scaffold command
Create new Tethys app or extension projects.
usage: tethys scaffold [-h] [-t {react,default,component}] [-e] [-d] [-o]
[--proper-name PROPER_NAME] [--description DESCRIPTION]
[--color COLOR] [--tags TAGS] [--author AUTHOR]
[--author-email AUTHOR_EMAIL] [--license LICENSE_NAME]
name [prefix]
Positional Arguments
- name
The name of the new Tethys app project to create. Only lowercase letters, numbers, and underscores allowed.
- prefix
The absolute path to the directory within which the new app should be scaffolded.
Default:
'/home/docs/checkouts/readthedocs.org/user_builds/tethys-platform/checkouts/latest/docs'
Named Arguments
- -t, --template
Possible choices: react, default, component
Name of template to use.
Default:
'default'- -e, --extension
Default:
False- -d, --defaults
Run command, accepting default values automatically.
Default:
False- -o, --overwrite
Attempt to overwrite project automatically if it already exists.
Default:
False- --proper-name
Proper name (i.e. title) of the app/extension.
- --description
Brief description of the app/extension.
- --color
Main theme color for the app. Does not apply to extensions.
- --tags
Tags for the app. Does not apply to extensions.
- --author
Author of the app/extension.
- --author-email
Email of the author of the app/extension.
- --license
License of the app/extension.