Captain

Features

Coming soon

Usage

Installation

Guided tutorial on path.cafe (coming soon)

``sh
npm install captain
`

API

$3

1. Write workflow

#### rate.js:
`js
export default function* rate(){
let rating = yield ["collect/number", {
message: "How would you rate this, from 1 to 10?",
min: 1,
max: 10,
initial: 5
}]
let reason = yield ["collect/text", {
message: Why did you rate this a ${rating}?
}]
return { rating, reason };
}
`

2. Call workflow using captain

`zsh
captain ./rate.js
`

$3

| Type | Props |
| --- | --- |
| collect/text | { message, initial, validate } |
| collect/secret | { message, validate } |
| collect/number | { message, initial, min, max, float, validate } |
| collect/date | { message, initial, locales, mask } |
| collect/confirm | { message, initial } |
| collect/toggle | { message, initial, active, inactive } |
| collect/select | { message, initial, multi, hint, choices ({ title, description, value, disabled }) } |
| font/[font_name] | { message, colors } |
| md | _markdown_ |
| progress | { message, promise } |

Examples

Coming soon

Details

Guided process to commit changes and/or submit a pull request
`sh
npm run save
``

$3

Coming soon

Acknowledgements

License

MIT © Marshall Brandt