doc: Add idea for composable functions
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
48b4b6ce96
commit
754ed0f898
1 changed files with 51 additions and 0 deletions
51
doc/draft-composable-functions.md
Normal file
51
doc/draft-composable-functions.md
Normal file
|
@ -0,0 +1,51 @@
|
||||||
|
# Composable functions
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
### With pipes
|
||||||
|
|
||||||
|
musala-pull SOURCE \
|
||||||
|
| musala-add TASK \
|
||||||
|
| musala-remove --purge SOMETASK \
|
||||||
|
| musala-push DEST
|
||||||
|
|
||||||
|
### With internal filters
|
||||||
|
|
||||||
|
Also writeable like
|
||||||
|
|
||||||
|
musala pull SOURCE % add TASK1 % remove --purge TASK2 % push DEST
|
||||||
|
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
### musala pull
|
||||||
|
|
||||||
|
Download all tasks from source
|
||||||
|
|
||||||
|
Get tasks from remote source
|
||||||
|
|
||||||
|
Writes tasks as JSON to stdout
|
||||||
|
|
||||||
|
### musala add
|
||||||
|
|
||||||
|
Add new task
|
||||||
|
|
||||||
|
Get tasks from stdin (json)
|
||||||
|
|
||||||
|
Add a new task
|
||||||
|
|
||||||
|
Writes tasks as JSON to stdout
|
||||||
|
|
||||||
|
### musala remove
|
||||||
|
|
||||||
|
* Get tasks from stdin (json)
|
||||||
|
* Mark a task as removed
|
||||||
|
* Remove tasks marked as remove (if --purge enabled)
|
||||||
|
* Writes tasks as JSON to stdout
|
||||||
|
|
||||||
|
### musala push
|
||||||
|
|
||||||
|
* Get tasks from stdin (json)
|
||||||
|
* Writes tasks to REMOTE DESTINATION
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue