Files
marqdo-cli/AGENTS.md
T
cflmy 2c7c4f31e7
Linux strict security lane (G-C) / strict isolation escape matrix (push) Waiting to run
ci/woodpecker/push/main Pipeline was successful
ci/woodpecker/manual/performance Pipeline was successful
CI / fmt + clippy + test (Linux x86_64) (push) Waiting to run
CI / schema instance validation + consumers (push) Waiting to run
CI / runtime contract (macos-latest) (push) Waiting to run
CI / runtime contract (windows-latest) (push) Waiting to run
release(3.0.0-beta.1): product version migration, beta gates, archive tooling and developer docs
REL-01: workspace/CLI/Analysis product version 3.0.0-beta.1 with updated
Cargo.lock; project.marqdo is enforced against the running core with
package.marqdo_range_invalid/package.marqdo_incompatible fail-closed
diagnostics; Tool SemVer prerelease negotiation tests; init template and
examples use the beta range. Verify init derives the project name from the
target directory instead of falling back to 'example'.

REL-02: beta support matrix is Linux x86_64 only; macOS/Windows are explicitly
experimental/unclaimed; strict policy and G4 Beta-only WARN are documented for
the release evidence.

REL-03: deterministic release packaging (tools/release/package.py) ships the
CLI and provider worker together with SOURCE_SHA, RELEASE_INFO.json,
known-limitations, specs, developer docs, examples incl. built plugin/provider
artifacts and consumers; tools/release/smoke.py cold-install tests the archive.

REL-04: docs/developers entry pages; corrected and self-contained third-party
integration handbook; stale Proposed/native-only/informational spec claims
fixed; release/status/compatibility/changelog/releasing docs updated.

REL-05: release_evidence.py gains an explicit beta profile
(BETA_RELEASE_CANDIDATE) distinct from the stable profile; Woodpecker build
step now packages and smoke-tests the archive on every pipeline.

Adds a runnable Resource Provider v2 example and corrects check --emit to
Analysis v2.
2026-11-22 02:31:32 +08:00

6.5 KiB
Raw Blame History

Marqdo CLI — Agent / Contributor Operating Rules

Start here: read docs/architecture/RFC-LANG-0002-unified-semantics.md — it is the single current language authority — and its normative summary spec/mapping.md + spec/expression.ebnf. Then read docs/DEVELOPMENT_BLUEPRINT.md (architecture baseline; its language-mapping sections are historical), docs/STATUS.md (what is actually implemented, including the landed RFC-LANG-0002 migration), the relevant spec/ files, docs/adr/ for decisions at their date, docs/contributor-guide.md, and tests/README.md plus the conformance fixtures. Do not assume any current implementation or legacy Marqdo syntax is authoritative.

For next-phase work, the authoritative release policy for the current 3.0.0-beta.1 line is docs/MARQDO_3_0_PRERELEASE_PLAN.md (beta gates, REL-01..REL-05, version axes, LTS conditions). docs/STABLE_RELEASE_IMPLEMENTATION.md (stable gates G-A/G-B/G-C) is historical roadmap input for the later stable release; it does not override the 3.0 prerelease plan. Also read docs/CORE_STABILIZATION_AND_ECOSYSTEM_GATE.md (historical stabilization spec, baseline 0adebe4), docs/NEXT_PHASE_IMPLEMENTATION.md (M0.6 plan), docs/EXTENSIBILITY_AUDIT.md (E01–E16), COMPATIBILITY.md and docs/security-gate.md. Older plans are historical input; the 3.0 prerelease plan is authoritative for current release decisions, and the stable-release spec applies only when the project moves from beta to stable. None describes implemented behavior; re-check against HEAD and tests. strict remains fail-closed until G-C passes.

The stable-release spec also governs scope: do not add a top-level CLI command, Knowledge/Proof/View special-casing, a second interpreter or a new package registry. Fix the current Windows/macOS CI behavior, protocol/environment correctness and release evidence before expanding the surface.

Non-negotiable architectural constraints

  1. New independent language/toolchain. Do not silently modify cflmy/marqdo or claim compatibility with its syntax, package format or plugin ABI.
  2. CommonMark/GFM/Math AST is the sole Markdown syntax structure. Do not implement a second Markdown parser or use regex heuristics to decide whether text is executable.
  3. The language has one Markdown→program mapping (RFC-LANG-0002): @exec/@knowledge heading modes with ancestor inheritance; only an Exec H2 is callable; Strong, Emph and inline Code are interchangeable one-statement payload carriers; if/else/while/end/return/params decide control flow; lists, block quotes and paragraphs are presentation containers with no instruction type. Invalid payloads are hard errors, never prose fallbacks. Do not reintroduce Strong=execute, Emph=return, ordered-list=branch, bullet-list=loop or block-quote=call, and do not add a per-file syntax switch, map_v1, --legacy or a second active spec.
  4. Prose and executable payloads may mix freely in one function/branch/loop body. Prose itself never causes an action; executable payloads with no owning H2 Exec function are errors (sem.exec_without_function).
  5. Marqdo is executed by its own Rust interpreter. Python/Node are optional foreign kernels, never the official compiler target.
  6. Code fences and math expressions create inert native Code and Formula values. Evaluation requires explicit calls and relevant capability grants. Inline Code spans are payload carriers only in an Exec scope; fenced code is never executed.
  7. YAML project/dependency and frontmatter imports must be explicit. Markdown Links are static references, never calls or imports. Calls are expressions inside executable payloads.
  8. Third-party plugins require a versioned C ABI and SDK. A C ABI is not a sandbox. Default third-party execution must be isolated; in-process native loading requires explicit trust.
  9. Side effects go through CapabilityHost; do not invent host bypasses for tests, plugins, math or foreign kernels. check and inspect cannot execute untrusted project code.
  10. Language semantics, package format, ABI, authorization defaults or public CLI behavior changes require an ADR + tests + spec updates.
  11. RFC-LANG-0002 is implemented by the frontend, marqdo-expression, IR lowering, runtime and the bundled stdlib. Keep spec/, implementation, fixtures, stdlib digest and docs in lockstep; there is no legacy mapper or per-file syntax switch to fall back to. Do not make a release claim beyond the evidence recorded in docs/STATUS.md.

Development workflow

  1. Identify the affected rule and cite RFC-LANG-0002 / spec/mapping.md (or, for architecture-only changes, the relevant docs/DEVELOPMENT_BLUEPRINT.md section).
  2. Update the normative spec in place first; there is never a second active syntax spec.
  3. Add a small .mq.md positive/negative conformance fixture and define the expected Markdown AST, execution IR and diagnostics.
  4. Implement only the smallest module that satisfies this fixture. Keep Markdown parser, semantic mapper, expression parser, runtime and host separated.
  5. Run formatting, clippy, unit tests, golden tests and relevant security/ABI compatibility tests (cargo fmt --check, cargo clippy --workspace --all-targets -- -D warnings, cargo test --workspace, cargo test -p marqdo-cli).
  6. Write the tradeoff and state of completion in the PR. Never say a feature is finished because a design example looks executable. Update spec/ and docs/STATUS.md when behavior or status changes; the docs describe what the code does and flag divergences explicitly.

Unresolved design topics

RFC-LANG-0002 resolves the old emphasis/control-role conflict: Strong, Emph and inline Code are equivalent carriers and controls are keywords with explicit end. Remaining topics still need separate Accepted ADRs (parameter inference policy, plugin memory ownership, strict platform isolation, future elif/for/break, knowledge anchors). Do not freeze them through undocumented code.

Priorities

P0 language contract maintenance (RFC-LANG-0002, single grammar, corpus and stdlib) → P1 independent interpreter → P2 references/CLI → P3 package/env → P4 sandbox → P5 math/foreign → P6 plugin ABI/SDK → P7 performance/release. Design the Host security boundary and ABI early, even if full implementation arrives later.

Never translate Marqdo into Python as the official execution method; never silently downgrade an invalid payload to prose, a requested strict sandbox to an unrestricted process, or the current syntax to a legacy mapper.