Estado do produto

Versão atual: 0.3.0-beta.3.

• leitura de arquivos obrigatoriamente via simplicio_file_read;
• handshake MCP valida que o processo é o Simplicio Runtime verdadeiro;
• falha fechada: sem Runtime, o agente não lê diretamente do disco;
• TUI, headless, workspace e ACP compartilham o mesmo backend de leitura;
• ao abrir uma pasta, o Runtime inicia o mapa geral em segundo plano;
• o modelo aparece como Simplicio-1 e usa tencent/hy3:free via OpenRouter;
• o tema padrão Simplicio Brasil usa verde e amarelo;
• escrita/exclusão usam o Runtime; apply_patch envia o plano completo pelo contrato atômico simplicio_edit, sem fallback local em sessões produtivas.

Para desenvolvimento local, forneça a credencial apenas pelo ambiente:

export OPENROUTER_API_KEY="..."

A chave nunca deve ser gravada no repositório nem distribuída no binário. A sincronização de login e assinatura Simplicio será adicionada numa atualização posterior ao beta, quando o cliente passará a consumir o gateway autenticado.

Veja docs/ARCHITECTURE.md para as fronteiras do produto.

Instalando o binário

A partir da 0.3.0-beta.1, releases assinadas (prerelease no GitHub) passam a ser publicadas por .github/workflows/release.yml, com checksum, SBOM e manifest assinado — veja RELEASE_NOTES_0.3.0-beta.3.md para o que já funciona e o que ainda falta (chave de assinatura de produção, build Windows, rollout gradual). Instale com:

curl -fsSL https://raw.githubusercontent.com/wesleysimplicio/simplicio-code/main/install.sh | bash

irm https://raw.githubusercontent.com/wesleysimplicio/simplicio-code/main/install.ps1 | iex

Ambos os scripts baixam apenas releases publicadas por este repositório (não a infraestrutura x.ai herdada em crates/codegen/xai-grok-pager/scripts/) e recusam a instalação se o checksum não bater.

simplicio-code --version

Building from source

Requirements:

• Rust — the toolchain is pinned by rust-toolchain.toml; rustup installs it automatically on first build.

• DotSlash — required so hermetic tools under bin/ (notably bin/protoc) can download and run. Install it and ensure dotslash is on your PATH before building:

  cargo install dotslash
  # or: prebuilt packages — https://dotslash-cli.com/docs/installation/
  /usr/bin/env dotslash --help   # sanity check
  

• protoc — proto codegen resolves bin/protoc via DotSlash, or falls back to a protoc on PATH / $PROTOC.

• ripgrep (rg) — release builds of xai-grok-tools and xai-grok-shell bundle a static rg binary for the in-app search/shell tools. Resolution order: (1) an explicit override env var always wins if set — GROK_TOOLS_BUNDLE_RG_PATH for xai-grok-tools, GROK_SHELL_BUNDLE_RG_PATH for xai-grok-shell — pointing at a local rg binary to bundle; (2) an rg already on PATH is detected automatically and bundled, no network access needed; (3) otherwise the build script downloads a pinned rg release from GitHub Releases, which requires outbound network access and fails on egress-restricted hosts/proxies. On such hosts, either install ripgrep so it's on PATH before building, or set the override env var.

• macOS and Linux are supported build hosts; Windows builds are best-effort and not currently tested from this tree.

cargo run -p xai-grok-pager-bin --bin simplicio-code
cargo build -p xai-grok-pager-bin --bin simplicio-code --release
cargo check -p xai-grok-pager-bin            # fast validation

O artefato é target/release/simplicio-code. O fluxo de autenticação Simplicio e o gateway de inferência serão conectados antes da primeira distribuição.

O launcher local tools/simplicio_code_launcher.sh procura primeiro os artefatos do checkout e, quando não há target/, usa a instalação por usuário em ~/.local/lib/simplicio-code/simplicio-code. Para selecionar outro binário, defina SIMPLICIO_CODE_BIN explicitamente.

Documentation

Simplicio-specific docs (start here for this fork):

• docs/QUICKSTART.md — install and first run, PT + EN
• docs/ARCHITECTURE.md — client, Runtime, and gateway boundaries
• docs/audits/issue-139-report.md — reproducible issue specification audit and closure decisions; its hash-guarded rewrite bundle provides owner-review drafts without mutating or closing issues
• docs/TROUBLESHOOTING.md — login, Runtime, mapa, rede, updater
• docs/privacy/telemetry.md — what telemetry exists, opt-out, privacy diagnose
• docs/privacy/network-destinations.md — every network destination the client can contact, the telemetry-scoped allowlist, and the network-capture test
• docs/migration/legacy-login-migration.md — design for the future login/entitlement migration (pending #3/#4)

Run python3 scripts/check_doc_links.py to validate every doc link and referenced cargo -p <crate> command below and under docs/.

Full online documentation for the underlying CLI is available at docs.x.ai/build/overview.

The user guide ships with the pager crate: crates/codegen/xai-grok-pager/docs/user-guide/ — getting started, keyboard shortcuts, slash commands, configuration, theming, MCP servers, skills, plugins, hooks, headless mode, sandboxing, and more.

Repository layout

[!IMPORTANT] The root Cargo.toml (workspace members, dependency versions, lints, profiles) is generated — treat it as read-only. Prefer editing per-crate Cargo.toml files.

Development

cargo check -p <crate>        # always target specific crates; full-workspace builds are slow
cargo test -p xai-grok-config # per-crate tests
cargo clippy -p <crate>       # lint config: clippy.toml at the repo root
cargo fmt --all               # rustfmt.toml at the repo root

Contributing

[!NOTE] External contributions are not accepted. See CONTRIBUTING.md.

License

First-party code in this repository is licensed under the Apache License, Version 2.0 — see LICENSE.

Third-party and vendored code remains under its original licenses. See:

• THIRD-PARTY-NOTICES — crates.io / git dependencies, bundled UI themes, and in-tree source ports (including openai/codex and sst/opencode tool implementations)
• crates/codegen/xai-grok-tools/THIRD_PARTY_NOTICES.md — crate-local notice for the codex and opencode ports (license texts + Apache §4(b) change notice)
• third_party/NOTICE — vendored Mermaid-stack index