Skip to content

Repository files navigation

quantara-toolkit

License: MIT Status: Milestone 1 in progress

Future developer tooling for Quantara — an open-source developer infrastructure platform for the Soroban smart contract ecosystem.

Status: Milestone 1 (read-only CLI) in progress. The runtime/ piece is still a placeholder, and the CLI's write operations (deploy) aren't built yet — see ROADMAP.md. But cli/ now has a real, working quantara init / projects list / projects get / logs, built against quantarahq/quantara-core's REST API the same way quantarahq/quantara-web is.

Part of the Quantara project:

Repo What it is
quantara-core Backend API + Soroban contract — the working MVP
quantara-web Next.js dashboard — the working MVP
quantara-toolkit (this repo) Read-only CLI in progress; runtime still a placeholder

Table of contents

Why this repo exists

The Quantara MVP (quantara-core + quantara-web) demonstrates the core developer workflow — create a project, deploy, inspect the contract registry — through a web dashboard talking to a REST API. That's a deliberate, narrow scope: per the project's own philosophy, "build a complete but minimal developer workflow instead of incomplete versions of every possible feature."

A CLI and an execution runtime are natural next steps once that foundation is validated — building them speculatively, before the API they'd depend on has proven itself, would be exactly the kind of premature, half-built feature sprawl the MVP philosophy exists to avoid. The read-only slice of the CLI (Milestone 1) carries no such risk: it's purely an alternative client against endpoints quantara-web already exercises, so it started once that read path existed. deploy (a write operation) and runtime/ are still deliberately held back until there's more signal to design them against.

Planned layout

quantara-toolkit/
├── cli/          Go CLI — quantara init / projects / logs implemented, deploy planned
│   └── README.md
├── runtime/      Future Go execution layer — sandboxes, deployment workers, simulation
│   └── README.md
├── examples/     Future example projects built with the CLI
│   └── README.md
├── ROADMAP.md    Milestone-by-milestone sequencing
├── README.md     you are here
├── CONTRIBUTING.md / CODE_OF_CONDUCT.md / SECURITY.md / CHANGELOG.md
└── LICENSE

The CLI (cli/)

Language: Go. Stack: Cobra for command structure; Viper is planned for Milestone 2's config file/env var support.

Commands:

quantara init                    scaffold a new Quantara project locally      (done)
quantara projects list           list all projects                            (done)
quantara projects get <id>       show a single project                        (done)
quantara logs <project-id>       show deployment/contract activity for a project (done)
quantara deploy                  deploy a contract via a running quantara-core instance (Milestone 2)

The CLI is an alternative client to the same REST API quantara-web already uses — not a separate backend, not a shortcut around quantara-core. If you can do it through the dashboard, you'll eventually be able to do it from the terminal, against the exact same endpoints. See cli/README.md for more detail.

The runtime (runtime/)

Language: Go. Possible responsibilities:

  • Sandbox environments — isolated execution for testing deployments before they touch a real network.
  • Deployment workers — background processes that carry out deployments asynchronously, replacing quantara-core's current synchronous simulation.
  • Simulation engine — dry-run a deployment and show what would happen without actually deploying.
  • Monitoring agents — watch deployed contracts and report activity back into quantara-core's contract registry.

Possible stack: Docker SDK for Go (worker isolation), gRPC (if the runtime ends up needing to be a separate service rather than invoked in-process). See runtime/README.md.

Relationship to quantara-core

Today, POST /api/deploy on quantara-core simulates a deployment synchronously and returns immediately — there's no queue, no worker, no real network call. The runtime described above is specifically where that simulation would eventually be replaced with something real, without changing the API contract the dashboard and CLI already depend on. That's the whole point of keeping this work in a separate repo behind a stable interface, rather than growing it directly inside quantara-core.

Roadmap

See ROADMAP.md for the full milestone breakdown. In short:

  • Milestone 0: quantara-core + quantara-web are a complete, working MVP.
  • Milestone 1 (in progress): a read-only CLI (quantara logs, projects list/get, plus local-only quantara init) — pure alternative client, no new backend work required.
  • Milestone 2: quantara deploy (a write operation), plus config file/env var support (Viper).
  • Milestone 3: the runtime — real deployment workers behind the existing API.

Explicitly not on this roadmap: multi-chain support, a hosted/managed Quantara, or anything resembling a general-purpose CI/CD platform. Different products, not natural extensions of this one.

Contributing

cli/'s Milestone 1 commands are implemented and open to PRs — see CONTRIBUTING.md. runtime/ and deploy are still design-stage; open a design discussion issue for those rather than sending code. If you'd rather work on the working MVP itself, quantara-core and quantara-web have open good-first-issues too.

FAQ

Why reserve empty directories instead of just writing this in the README? Because cli/, runtime/, and examples/ each have their own README describing what's planned specifically for that piece, and because a real directory structure makes the intended shape of the eventual monorepo-within-a-repo concrete and linkable, rather than an abstract paragraph.

Why Go for the CLI and runtime, when the backend is Java and the frontend is TypeScript? A CLI distributed as a single static binary is a much better experience in Go than in Java (no JVM startup cost, no bundling a runtime) or Node (no node_modules to ship). The runtime's likely need for lightweight process/container orchestration also fits Go's ecosystem (Docker SDK for Go, gRPC) better than the alternatives.

When will deploy and runtime/ actually start being built? No committed timeline — see ROADMAP.md's framing. They start being real work once there's more usage to design against, rather than guessing at ergonomics in a vacuum.

License

MIT

About

Quantara Toolkit — future developer tooling (CLI, runtime) for the Quantara Soroban developer infrastructure platform

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages