cookie-composer¶
Render templates using composition.
Usage:
cookie-composer [OPTIONS] COMMAND [ARGS]...
Options:
Name | Type | Description | Default |
---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
Subcommands
- add: Add the template or configuration PATH_OR_URL to an existing project.
- auth: Authenticate cookie-composer to a service.
- create: Create a project from the template or configuration PATH_OR_URL in using optional [CONTEXT_PARAMS].
- link: Link an existing git repo to the template or composition PATH_OR_URL using optional [CONTEXT_PARAMS].
- update: Update the project to the latest version of each template.
cookie-composer add¶
Add the template or configuration PATH_OR_URL to an existing project.
Usage:
cookie-composer add [OPTIONS] PATH_OR_URL [CONTEXT_PARAMS]...
Options:
Name | Type | Description | Default |
---|---|---|---|
--verbosity , -v |
text | Either CRITICAL, ERROR, WARNING, INFO or DEBUG | INFO |
--no-input |
boolean | Do not prompt for parameters and only use cookiecutter.json file content. Defaults to deleting any cached resources and redownloading them. | False |
-c , --checkout |
text | branch, tag or commit to checkout after git clone | None |
--directory |
text | Directory within repo that holds cookiecutter.json file for advanced repositories with multi templates in it | None |
-f , --overwrite-if-exists |
boolean | Overwrite the contents of the output directory if it already exists | False |
-s , --skip-if-file-exists |
boolean | Skip the files in the corresponding directories if they already exist | False |
--default-config |
boolean | Do not load a config file. Use the defaults instead | False |
-d , --destination |
directory | The directory to add the templates to. Defaults to the current working directory. | <function <lambda> at 0x7f1d1a4e5630> |
--accept-hooks |
choice (yes | ask | no | first | last | all | none ) |
Accept pre/host hooks | all |
--help |
boolean | Show this message and exit. | False |
cookie-composer auth¶
Authenticate cookie-composer to a service.
Usage:
cookie-composer auth [OPTIONS] COMMAND [ARGS]...
Options:
Name | Type | Description | Default |
---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
cookie-composer auth login¶
Authenticate to a service.
Usage:
cookie-composer auth login [OPTIONS]
Options:
Name | Type | Description | Default |
---|---|---|---|
-p , --git-protocol |
choice (https | ssh ) |
The protocol to use for git operations | https |
-h , --service |
text | The host name of the service to authenticate with | github.com |
-s , --scopes |
text | Additional authentication scopes to request | None |
--with-token |
filename | Read token from standard input | None |
--help |
boolean | Show this message and exit. | False |
cookie-composer auth token¶
Print the auth token cookie-composer is configured to use.
Usage:
cookie-composer auth token [OPTIONS]
Options:
Name | Type | Description | Default |
---|---|---|---|
-h , --service |
text | The host name of the service to authenticate with | github.com |
--help |
boolean | Show this message and exit. | False |
cookie-composer create¶
Create a project from the template or configuration PATH_OR_URL in using optional [CONTEXT_PARAMS].
Usage:
cookie-composer create [OPTIONS] PATH_OR_URL [CONTEXT_PARAMS]...
Options:
Name | Type | Description | Default |
---|---|---|---|
--verbosity , -v |
text | Either CRITICAL, ERROR, WARNING, INFO or DEBUG | INFO |
--no-input |
boolean | Do not prompt for parameters and only use cookiecutter.json file content. Defaults to deleting any cached resources and redownloading them. | False |
-c , --checkout |
text | branch, tag or commit to checkout after git clone | None |
--directory |
text | Directory within repo that holds cookiecutter.json file for advanced repositories with multi templates in it | None |
-f , --overwrite-if-exists |
boolean | Overwrite the contents of the output directory if it already exists | False |
-s , --skip-if-file-exists |
boolean | Skip the files in the corresponding directories if they already exist | False |
--default-config |
boolean | Do not load a config file. Use the defaults instead | False |
-d , --destination , -o , --output-dir |
directory | The directory to render the templates to. Defaults to the current working directory. | <function <lambda> at 0x7f1d1a4e5510> |
--accept-hooks |
choice (yes | ask | no | first | last | all | none ) |
Accept pre/host hooks | all |
--help |
boolean | Show this message and exit. | False |
cookie-composer link¶
Link an existing git repo to the template or composition PATH_OR_URL using optional [CONTEXT_PARAMS].
Usage:
cookie-composer link [OPTIONS] PATH_OR_URL [CONTEXT_PARAMS]...
Options:
Name | Type | Description | Default |
---|---|---|---|
--no-input |
boolean | Do not prompt for parameters and only use cookiecutter.json file content. Defaults to deleting any cached resources and redownloading them. | False |
-c , --checkout |
text | branch, tag or commit to checkout after git clone | None |
--directory |
text | Directory within repo that holds cookiecutter.json file for advanced repositories with multi templates in it | None |
-f , --overwrite-if-exists |
boolean | Overwrite the contents of the output directory if it already exists | False |
-s , --skip-if-file-exists |
boolean | Skip the files in the corresponding directories if they already exist | False |
--default-config |
boolean | Do not load a config file. Use the defaults instead | False |
-d , --destination |
directory | The directory to link the template to. Defaults to the current working directory. | <function <lambda> at 0x7f1d1a4e5870> |
--help |
boolean | Show this message and exit. | False |
cookie-composer update¶
Update the project to the latest version of each template.
Usage:
cookie-composer update [OPTIONS] [CONTEXT_PARAMS]...
Options:
Name | Type | Description | Default |
---|---|---|---|
--no-input |
boolean | Do not prompt for parameters and only use cookiecutter.json file content. Defaults to deleting any cached resources and re-downloading them. | False |
-d , --destination |
directory | The directory to update. Defaults to the current working directory. | <function <lambda> at 0x7f1d1a4e52d0> |
--help |
boolean | Show this message and exit. | False |