Skip to content
Permalink
Browse files

Document #63

  • Loading branch information...
sindresorhus committed Sep 29, 2017
1 parent 7f54d4b commit 554119b0af09cb33aea4e709c0572043cd00586d
Showing with 25 additions and 0 deletions.
  1. +25 −0 readme.md
@@ -82,6 +82,31 @@ Type: `Object` `Array` `string`

Can either be a string/array that is the `help` or an options object.

##### flags

Type: `Object`

Define argument flags.

The key is the flag name and the value is an object with any of:

- `type`: Type of value. (Possible values: `string` `boolean`)
- `alias`: Usually used to define a short flag alias.
- `default`: Default value when the flag is not specified.

Example:

```js
flags: {
unicorn: {
type: 'string',
alias: 'u',
default: 'rainbow'
}
}
```


##### description

Type: `string` `boolean`<br>

0 comments on commit 554119b

Please sign in to comment.
You can’t perform that action at this time.