-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2f33646
commit 2844931
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Documentation | ||
|
||
- Getting started (see README) | ||
- Commands | ||
- Properties | ||
- Annotations | ||
- Root level commands | ||
- Sub commands | ||
- Options | ||
- Properties | ||
- Annotations | ||
- Global options | ||
- Command options | ||
- Scripts | ||
- Configuration | ||
- Application properties | ||
- Name | ||
- Description | ||
- Version | ||
- Log | ||
- Level | ||
- Prefix | ||
- Help | ||
- Autocompletion | ||
|
||
## Commands | ||
|
||
### Properties | ||
|
||
| Property | Description | YAML key | Type | Required | | ||
|-------------|------------------------------------------------------|---------------|--------|----------| | ||
| Name | The name of the command | `name` | string | true | | ||
| Path | Relative path to the script containing the command | `path` | string | true | | ||
| Description | Description of the command, displayed in help output | `description` | string | false | | ||
| Help | Usage example for the command | `help` | string | false | | ||
| Hidden | When set to true, hides the command from help output | `hidden` | boolean | false | | ||
|
||
|
||
### Annotations | ||
|
||
| Property | Format | | ||
|-------------|-----------------------------------------------| | ||
| Description | `# centry.cmd[<command>]/description=<value>` | | ||
| Help | `# centry.cmd[<command>]/help=<value>` | | ||
| Hidden | `# centry.cmd[<command>]/hidden=<value>` | |