Repo brief: QuipNetwork/xq-rs

Generated by RepoPilot · document generated 2026-09-15 · concise human review Evidence snapshot · analyzed 2026-09-15T17:46:57.580Z · commit d5fe5e2aeb6f

Verdict

Mixed — Solo project — review before adopting

• Last commit 5w ago
• AGPL-3.0 licensed
• Tests present

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests

What it is

Aglais XQVM is a hardware-agnostic virtual machine and bytecode compiler for quantum computing optimization problems, specifically targeting X-quadratic models (QUBO/Ising formulations) for quantum annealers. It provides a unified intermediate representation similar to LLVM but for binary optimization: you write .xqasm text assembly, compile it to .xqbc bytecode, and execute it on the XQVM stack-based interpreter with a 256-slot register file. Monorepo with four independent crates: crates/bytecode (instruction encoding, binary codec, jump table), crates/asm (Pest-based parser for .xqasm → bytecode), crates/disasm (bytecode → human-readable listing), crates/cli (CLI entry…

Start here

Open these first:

• crates/vm/src/vm.rs — Core VM execution engine; handles instruction dispatch, state management, and quantum circuit simulation—all contributors…
• crates/bytecode/src/types/opcode.rs — Defines all opcodes and their semantics; any instruction set changes require updates here.
• crates/asm/src/parser.rs — Parses XQASM assembly syntax into AST; grammar changes cascade through the entire toolchain.
• crates/bytecode/src/codec.rs — Encodes/decodes binary bytecode format; serialization bugs affect all downstream users.
• crates/bytecode/src/builder.rs — Constructs bytecode programmatically; the primary API for code generation tools.

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

# Install Rust stable
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Clone and install dev dependencies
git clone https://gitlab.com/piqued/quip-aglais.git xq-rs
cd xq-rs
make deps

# Build release binaries
cargo build --release

# Binaries appear at: target/release/xqasm, target/release/xqdism, target/release/xqvm

Daily commands:

# Assemble a .xqasm program to bytecode
./target/release/xqasm program.xqasm -o program.xqbc

# Disassemble bytecode to inspect (human-readable listing)
./target/release/xqdism program.xqbc

…shortened for this brief.

Key cautions & unknowns

• Solo or near-solo (1 contributor active in recent commits)
• AGPL-3.0 is copyleft — check downstream compatibility
• No obvious required environment variables or external services in the provided data. However: (1) The no_std + alloc requirement means some stdlib conveniences are unavailable — memory allocation must be explicit.…
• Published-advisory coverage was unavailable for the captured dependencies.
• Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

• Repository source
• Open issues
• Recent pull requests

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

For the complete agent context, use the CLAUDE.md or Cursor rules export.