README
¶
xc - eXeCute project tasks from a readme file
Installation
Go:
go install git.sr.ht/~jdav/xc/cmd/xc@latest
Brew:
brew tap joe-davidson1802/xc
brew install xc
Install autocompletion for bash:
xc -complete
Usage
To list available tasks run the following.
xc
To run a task simply run the following replacing task with the task to be run.
xc task
To run a task from a file not named README.md run with the -f of --file flag.
xc --file OTHERFILE.md task
Syntax
Task section
To signify the start of the task definition section create a heading name "Tasks". If a heading of the same level or greater than the "Tasks" heading is found this signifys the end of the Task section.
Tasks
- Tasks go here
Another heading - Ends the task section
Task definition
Once in the task section a task can be defined by a subheading with a lower level:
### taskname
taskdescription
Requires: task-dependency1, task-dependency2
```
command
```
Name
The name is denoted by a heading lower than the Tasks heading.
Description
Anything between the task name and the task command, that is not a "Requires:" section is a description.
Dependencies
Other tasks can be ran by defining dependencies at the beginning.
They are signified by the Requires: prefix, they can be comma delimited or on separate lines.
The following are equivelant:
Requires: task1, task2, task3
Requires: task1
Requires: task2, task3
Directory
Directory by default will be the current working directory. However, if you provide a "Directory:" section then it can be overridden.
Environment Variables
Environment variables can be set with "Env:".
Command
The tasks command is signified by a md codeblock.
command --args
Example
Tasks
test
Test the project.
go test ./...
get
Get the project dependencies.
go get ./...
tag
Deploys a new tag for the repo.
Also runs tests
Requires: test
sh ./push-tag.sh
ls
Directory: ./parser
ls
echoenv
Env: SOME_VAR=test
printenv SOME_VAR
combo
Runs multiple commands but doesn't have it's own.
Requires: echoenv, ls
Directories