Skip to content

Commit

Permalink
added documentation for command line tool
Browse files Browse the repository at this point in the history
  • Loading branch information
emptymalei committed May 9, 2021
1 parent f272eaa commit 752f4c0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/references/command/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Command Line Tool

`haferml.command` module contains the command toolkits. To find all the commands, use `haferml --help`.

### Creating Config File Templates

To create a config file template for your project, use the command `haferml config path/to/your/config/file.json`. For more information, run the command `haferml config --help`.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ nav:
- "Utils":
# - "Utils": references/utils/index.md
- "utils.sugar": references/utils/sugar.md
- "Commandline":
- "Commandline Tool": references/command/index.md
- "Lab":
- "Lab": references/lab/index.md
- "Changelog": changelog.md

0 comments on commit 752f4c0

Please sign in to comment.