Skip to content

Commit

Permalink
Started documenting commands.
Browse files Browse the repository at this point in the history
  • Loading branch information
kristofferahl committed Feb 28, 2021
1 parent 2f33646 commit 2844931
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/index.md
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>` |

0 comments on commit 2844931

Please sign in to comment.