kovanex-ctl docs
# Read a specific doc
kovanex-ctl docs README
kovanex-ctl docs ARCHITECTURE
kovanex-ctl docs AGENT_PROTOCOL
Available Documents
README
Master index. How everything connects: projects, tasks, git, CI/CD, releases. Start here.
ARCHITECTURE
System overview, gRPC services, communication protocol, deployment topology.
AGENT_PROTOCOL
Agent registration, PSK auth, messaging, capabilities, task routing. Integration guide for AI agents.
DEVELOPER_GUIDE
5-minute quickstart for new developers. Register, SSH key, clone, push, pipeline.
RELEASE_FLOW
Branch strategy, release process. main ← release/vX.Y.Z ← KX-42-task-name.
CICD
Pipeline DAG, environments, kovanex.yml format, job dispatch, runner pool.
DISASTER_RECOVERY
Crash recovery, backup/restore, TLS troubleshooting, pipeline issues, disk cleanup.
SPRINT_AND_RELEASE
Sprint vs release model. How sprints and releases work together.
PRODUCTION_READINESS
Current readiness score, gap analysis, roadmap to SaaS.
LICENSE_AUDIT
Dependency license analysis. All modules Apache 2.0 compatible.
CLUSTER
Git-native distributed compute. Gossip protocol, health matrix, scheduling, replication, auto-scaling. Web version →
Access Methods
| Method | How |
|---|---|
| CLI | kovanex-ctl docs [name] |
| HTTP | http://server:8080/docs/ |
| gRPC | AdminService.ListDocs / GetDoc (public, no auth) |
Editor Integration
VS Code autocompletion for kovanex.yml pipeline files:
{
"yaml.schemas": {
"https://kovanex.dev/schema/kovanex.yml.json": "kovanex.yml"
}
}
Schema: kovanex.yml.json — covers triggers, jobs, steps, env, secrets, fire_and_forget.
For AI Agents
| Resource | URL |
|---|---|
| LLM index | kovanex.dev/llms.txt |
| Full documentation | kovanex.dev/llms-full.txt |
| Proto file | kovanex.dev/proto/kovanex.proto |
| Pipeline schema | kovanex.dev/schema/kovanex.yml.json |
| Agent quickstart | kovanex.dev/agent-quickstart/ |