Expand description
Core library for the ask CLI (Rust port of @pleaseai/ask).
Phase 0: this crate is a walking skeleton. The command surface is defined in
cli, but the per-command logic is ported from the TypeScript
implementation (packages/cli/src/) module by module in later phases (see
the rust-port-20260704 track). Until a command is ported it reports a
“not yet ported” notice via NotPorted.
Modules§
- agents
AGENTS.mdgeneration — maintains the<!-- BEGIN:ask-docs-auto-generated -->block and a@AGENTS.mdreference inCLAUDE.md. Rust port ofagents.ts.- ask_
json ask.jsonschema — Rust port ofpackages/schema/src/ask-json.ts.- cli
- Command-line surface for
ask, mirroringpackages/cli/src/index.ts. - commands
- Lazy command implementations (
ask src/docs/fetch/add/ …). - discovery
- Convention-based discovery helpers. On this branch only
candidatesis wired into a command (ask add’s offline-first docs-path probe); the local adapter chain (local-ask / local-intent / local-conventions) thatinstallconsults upstream is not yet materialized here. - http
- A small injectable HTTP client abstraction shared by the registry lookup, the ecosystem resolvers, and (later) the web/llms-txt sources.
- ignore_
files - Vendored-docs ignore-file management. Rust port of
ignore-files.ts. - install
- Lazy-first
ask installorchestrator. Rust port ofinstall.ts. - io
ask.json/.ask/resolved.jsonfile I/O + hashing — Rust port ofpackages/cli/src/io.ts.- list
ask listmodel + renderer. Rust port oflist/{model,aggregate,render}.tsanddisplay/table.ts.- lockfiles
- Lockfile readers — translate a dependency name into the version pinned by
the project’s package manager. Rust port of
packages/cli/src/lockfiles/. - markers
- Marker-block helpers — Rust port of
packages/cli/src/markers.ts. - registry
- Registry spec parsing, ecosystem detection, and the registry HTTP lookup —
Rust port of
packages/cli/src/registry.ts. - resolved
.ask/resolved.jsonschema — Rust port ofpackages/schema/src/resolved.ts.- resolvers
- Ecosystem resolvers — map a package name + version to a GitHub
owner/repoplus a git ref, over the injectablecrate::http::HttpClient. Rust port ofpackages/cli/src/resolvers/. - skill
- Claude Code skill generation — writes a lazy-first
SKILL.mdper library. Rust port ofpackages/cli/src/skill.ts. - skills
- Standalone agent-skills subsystem for
ask skills— vendoring producer-side skill directories into.ask/skills/and symlinking them into detected coding-agent directories. Separate from the docs-skill generation inskill.rs. Rust port ofpackages/cli/src/skills/. - sources
- Source adapters — fetch docs from github / npm / llms-txt (web is deferred)
and materialize them into the global store. Rust port of
packages/cli/src/sources/. - spec
- Spec parsing for
ask.jsonlibrary entries — Rust port ofpackages/cli/src/spec.ts. - storage
- Project-local docs materialization + the
ask listview. Rust port ofpackages/cli/src/storage.ts. - store
- Global ASK store — atomic writes, entry locking, content verification, the
store-version marker, and quarantine. Rust port of
store/index.ts.
Structs§
- NotPorted
- Sentinel error for a command whose logic has not been ported to Rust yet.