code-sous is a function execution layer for agent-built automation.
Complete documentation lives at the project's GitHub wiki:
https://github.com/osvaldoandrade/sous/wiki — start with the Home page for
role-based reading paths (developers, operators, contributors). The local
wiki/ directory in this repository is the writable source for those pages;
see wiki/README.md for the publishing workflow.
- Control plane:
cmd/cs-control - Data plane ingress:
cmd/cs-http-gateway,cmd/cs-scheduler,cmd/cs-cadence-poller - Execution plane:
cmd/cs-invoker-pool - CLI:
cmd/cs-cli - Shared libraries under
internal/
make test
make buildRequires git and go.
macOS, Linux, and Windows via Git Bash/MSYS2/Cygwin/WSL:
curl -fsSL https://raw.githubusercontent.com/osvaldoandrade/sous/main/install.sh | shOr via npm, which installs a prebuilt binary from GitHub Releases:
npm install -g @osvaldoandrade/cs@latestCopy and edit the example file, then point each service at it:
cp config.example.yaml config.yamlEach service reads --config config.yaml. Plugin drivers are configured under
the plugins block (plugins.authn.driver, plugins.persistence.driver,
plugins.messaging.driver). The wiki's Operators-Configuration-Reference page
documents every field.
A local dependency stack is provided for smoke tests:
docker compose up -dServices included: KVRocks and Redpanda (Kafka-compatible codeQ).
./bin/cs-control --config config.yaml
./bin/cs-http-gateway --config config.yaml
./bin/cs-invoker-pool --config config.yaml
./bin/cs-scheduler --config config.yaml
./bin/cs-cadence-poller --config config.yaml./bin/cs auth login --tenant t_abc123 --token "$CS_TOKEN" --api-url http://localhost:8080
./bin/cs fn init reconcile
./bin/cs fn test --path reconcileSee the wiki's Developers-CLI page for the full command reference.