StewardX CLI
Logo converted to ASCII via https://asciiart.club/
The CLI to control StewardX
This is the official CLI to control StewardX. Made with #clap.
Getting started
If you're a linux x64 user, then you're in luck! Just download the precompiled binary or use the following utility:
$ curl https://raw.githubusercontent.com/gokayokyay/stewardx-cli/master/install.sh --output install.sh
$ chmod +x install.sh
$ ./install.sh
It'll handle everything for you, note: it's new and I'm pretty sure it won't work out for everyone.
If you're not, it's okay. Clone the repository and build it:
$ git clone https://github.com/gokayokyay/stewardx-cli
$ cd stewardx-cli
$ cargo build --release
When the build is completed, there'll be a file named stewardx-cli located in target/release/ directory. For ease of use rename the file, create a directory to use the binary and append it to your profile, like:
$ mkdir -p $HOME/.stewardx
$ mv target/release/stewardx-cli $HOME/.stewardx/stxctl
$ echo "export PATH=\"\$PATH:/\$HOME/.stewardx\"" >> $HOME/.bashrc
$ source $HOME/.bashrc
Now you're ready! Run:
$ stxctl -h
to see the help message.
Usage
Install StewardX
To install StewardX, just run the install command, like so:
$ stxctl install
Start StewardX
To start the StewardX (daemonized) issue the run or start command.
$ stxctl run
# or
$ stxctl start
Stop StewardX
I guess you got it but here it is:
$ stxctl stop
Create a task
Okay here's the fun part. To create a task you need to run:
$ stxctl tasks create <task_type> [ARGS]
It looks complicated but it's not, let's create a hello world printer command task:
$ stxctl tasks create cmd -n "My first task" -c "echo Hello world!" -f Hook
Where
- -n is name of the task
- -c is the command to execute
- -f is the frequency of the task
After executing the command above you'll get an output like:
Task ID | Name | Type | Frequency
---------------------------------------------------------------------------------
0558b548-d118-4c46-9309-e040b486a92b | first task | CmdTask | Hook
Voila! You've created your first task.
Listing tasks
To list tasks
$ stxctl tasks list
To list active tasks
$ stxctl tasks active
Executing and aborting tasks
To execute
$ stxctl tasks execute <id>
To abort
$ stxctl tasks abort <id>
and replace with the id of the task.
Listing reports
To list last 10 reports:
$ stxctl reports latest
To list a specific task's reports
$ stxctl reports -t <id>
and replace with your task's id.
To list a single report:
$ stxctl reports list <id>
where id is your report's id.
16 Dec 18, 2022
20 Nov 26, 2022
2 Sep 25, 2022
2 Jan 24, 2022
33 Nov 23, 2022
23 Jan 3, 2023
22 Dec 6, 2022
7 Dec 18, 2022
119 Dec 28, 2022
12.1k Jan 2, 2023
4 Aug 1, 2022
2.1k Dec 31, 2022
9 Dec 29, 2022
5 Oct 19, 2022
6 Oct 4, 2022
11 Aug 9, 2022
259 Jan 3, 2023
12 Dec 23, 2022
19 Jan 31, 2023
354 Nov 14, 2022
28 Nov 21, 2022
427 Dec 24, 2022
46 Jan 8, 2023
70 Jan 3, 2023
1 Oct 26, 2021
35 Mar 1, 2022
2.2k Dec 24, 2022
15 Dec 27, 2022