xec is a simple command executor.
Command, it's arguments and configuration of how to run it, is referred as task.
Xec reads a yaml based configuration file in either current directory and in home directory of the user. It is also possible to import other configurations file via the configuration file..
Reading configuration from the current working directory has advantages of per-project configuration structure.
It allows you to control environment of the command execution, such as timeout, environment values, restart behavior and so on.
Environment values can be filtered, either to pass or block values based on regex match, also adding environment values is trivial. Xec also supports reading .env file in the current directory, and reads it by default.
xec has the capability of:
- Dynamic sub-command generation based on the aliases of tasks
- Adding extra arguments via cli
- Grouping tasks as task lists
- Run tasks in parallel (via task lists)
- Restart task based on exit code, failure or success
- Filtering and adding environment values that are passed to the command
- Importing multiple configurations
Example run
❯ xec k ps
> kubectl get pods
No resources found in default namespace.
> kubectl get svc
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 145m
❯ cat examples/kubernetes.xec.yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/leventogut/xec/main/schema/xec-yaml-schema.json
# verbose: true
namespace: k
tasks:
- alias: gp
cmd: kubectl
args:
- get
- pods
- alias: gs
cmd: kubectl
args:
- get
- svc
taskLists:
- alias: ps
taskAliases:
- gp
- gsVisit the releases page or latest release page.
# set the version
export XEC_VERSION=v0.0.10
# Download the archive suits to your OS and architecture.
curl -L -o xec.tar.gz https://github.com/leventogut/xec/releases/download/${XEC_VERSION}/xec_Linux_x86_64.tar.gz
# Extract the archive
tar -xzvf xec.tar.gz
# Move the binary (might need root/sudo, depending on the path)
mv xec /usr/local/bin# Set the version
export XEC_VERSION=v0.0.10
# Download checksums file
curl -L -o xec_checksums.txt https://github.com/leventogut/xec/releases/download/${XEC_VERSION}/xec_${XEC_VERSION}_checksums.txt
# Get checksum
sha256sum xec.tar.gz
# Compare the checksum from the filego install github.com/leventogut/xec You can also copy the executable from the container image repository.
FROM alpine:latest
COPY --from=docker.io/leventogut/xec:latest /xec /xecTo see all available aliases just enter with no argument, it will read all configurations and generate the sub-commands/aliases.
In the following output build and env are aliases available.
Description of an alias command constitutes the command to be run and its arguments.
❯ xec xec on main [!?] via 🐳 desktop-linux via 🐹 v1.20.4 with unknown env
Simple command executor.
Usage:
xec <flags> <alias> -- [additional-args] [flags]
xec [command]
Available Commands:
build goreleaser release --snapshot --clean
completion Generate the autocompletion script for the specified shell
env printenv
help Help about any command
init initialize a configuration file in the current directory.
version Print the version number
Flags:
--config string config file to read (default is ~/.xec.yaml, $PWD/.xec.yaml)
--debug Debug level output.
-h, --help help for xec
--ignore-error Ignore errors on tasks.
--log-file string Filename to use for logging.
--no-color Disable color output.
--quiet No output except errors].
--verbose Verbose level output.
Use "xec [command] --help" for more information about a command.
exit status 1If no arguments are given, it exits with an exit code of 1.
To run a task, just enter name of the alias (and additional parameters if required).
xec mylsArguments after "--" is appended to the tasks' config arguments.
An example with additional arguments:
xec --ignore-errors myls -- -h- Verbose: true
- Debug: false
- Config: ""
- NoColor: false
- Quiet: false
- IgnoreErrors: false
- Timeout: 600s
xec uses Cobra for it's command generation.
An initial, skeleton configuration can be created via:
❯ xec init
2024-02-10T21:33:54+01:00 | [SUCCESS] | Init configuration is written to file .xec.yaml.| Feature | Documentation | Code |
|---|---|---|
| Simple | examples/simple.md | examples/simple.xec.yaml |
| Parallel execution | examples/parallel.md | examples/parallel.xec.yaml |
| Ignore error | examples/ignore-error.md | examples/ignore-error.xec.yaml |
| Restart on failure | examples/restart-on-failure.md | examples/restart-on-failure.xec.yaml |
| Restart on success | examples/restart-on-success.md | examples/restart-on-success.xec.yaml |
| Import Configurations | examples/import.md | examples/import.xec.yaml |
All configuration options of a task:
tasks:
- alias: myls
description: Execute ls with params.
cmd: ls
args:
- "-al"
- "-h"
timeout: 10 # Timeout is 10 seconds
environment:
passOn: true # Pass the environment key/values that Xec receives to the process or not.
values: # Additional environment values to pass to the process.
key: value
environment: prod
acceptFilterRegex: # Include the environment values matches the regex.
- "XEC_*"
rejectFilterRegex: # Don't include the environment values matches the regex.
- "SECRET*"
- "AWS*"
debug: true # Enable debug on Xec about this task.
logFile: "myls.log" # Log to this file.
ignoreError: true # Ignore if task is errored.
restartOnSuccess: false
restartOnFailure: falseYou can ignore (and continue) an errored tasks. This can be achieved in three levels, TaskDefaults, Task, TaskLists. TaskDefaults set's all task instances, while Task level affects individual. The other level affects TaskList which affects all tasks in the task list.
Restarting the task based on the exit code is supported as well, with restartOnSuccess and restartOnFailure
JSON schema can be found here
Contributions are most welcome. Please create a feature branch and work on that. Once your feature is ready raise PR.
Release build is done with goreleaser in GH Actions.
goreleaser release --snapshot --cleanOR
xec buildWhen there is a version tag attached, build and release is automatically done.
git commit -m "doing some stuff related to ..."
git tag -a v0.1.0 -m "First release"
git push origin v0.1.0
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent