ship: v0.1 Foundation milestone complete (#1)

2026-06-03 20:08:57 +00:00
parent 55aae5347e
commit be9afa2d2c
59 changed files with 4152 additions and 36 deletions
@@ -0,0 +1,59 @@
+# Orca
+
+Offline/CLI-first orchestration engine inspired by HashiCorp Nomad, far simpler than Kubernetes.
+
+## Status
+
+**v0.1: Foundation** — see [.ciagent/ROADMAP.md](.ciagent/ROADMAP.md) for the 6-phase plan.
+
+## Pillars
+
+- **Simplicity** — single binary, minimal dependencies
+- **AI-first** — CLI designed for both humans and AI agents
+- **Offline-first** — no cloud dependencies
+- **CLI-first** — primary interface is the command line
+- **Security before features** — NFRs ship before new functionality
+- **Bug fixes before features** — stability is paramount
+- **NFRs before features** — observability and auditability first
+
+## Quickstart
+
+```bash
+# Build
+make build
+
+# Run
+./bin/orca version
+./bin/orca --help
+
+# Initialize local state
+./bin/orca init
+```
+
+## Subcommands
+
+| Command | Description | Status |
+|---------|-------------|--------|
+| `orca version` | Print version info | ✅ Phase 1 |
+| `orca init` | Initialize local orca state | ✅ Phase 1 (stub) |
+| `orca status` | Show orca daemon status | ✅ Phase 1 (stub) |
+| `orca node` | Node management (`join`, `leave`, `list`) | Phase 2 |
+| `orca job` | Job management (`run`, `list`, `stop`, `logs`) | Phase 3 |
+
+## Development
+
+```bash
+make build      # Build binary to ./bin/orca
+make test       # Run tests with race detection
+make lint       # Run golangci-lint
+make fmt        # Format code
+make release    # Build + create Gitea release (Phase 6)
+```
+
+## Architecture
+
+See [.ciagent/ARCHITECTURE.md](.ciagent/ARCHITECTURE.md) for full architecture details.
+
+## License
+
+MIT — see [LICENSE](LICENSE).