CLI Documentation
Table of Contents
Invocation
$ profile-readme [...]
You can also invoke the command through the Python interpreter from the command line:
$ python3 -m profile_readme [...]
Getting Help
$ profile-readme --version # show the profile-readme version
$ profile-readme -h | --help # show help message on command line
CLI
profile-readme
A CLI tool for generating a GitHub profile README.
profile-readme [OPTIONS] COMMAND [ARGS]...
Options
- -v, --version
Show the version and exit.
init
Initiate a new profile README project using the Jinja2 template engine.
profile-readme init [OPTIONS]
Options
- --template <template>
The ouptut path for the README template file.
render
Render the README template and save it in a README file.
profile-readme render [OPTIONS]
Options
- --template <template>
The path of the README template file.
- Default
README-TEMPLATE.md
- --readme, --output <readme>
The ouptut path for the README file.
- Default
README.md
- --user <user>
The GitHub username.
- Default
octocat
- --verbose, --quiet
Make the operation more talkative.
- Default
True
Environment variables
- TEMPLATE
Provide a default for
--template
- README
Provide a default for
--readme
- GITHUB_ACTOR
Provide a default for
--user