{"ok":true,"site":"docs-rs","host":"docs.rs","about":"docs.rs is the documentation host for Rust crates. This CLI searches crates, resolves the best match, reads crate pages (build status, builds, features, versions, source files), reads rustdoc pages and item lists, and browses release listings, failures, the build queue and the Atom feed.","commands":[{"command":"search-crates","summary":"Search Rust crates on docs.rs by keyword, optionally sorted by downloads or recency","params":[{"name":"query","type":"string","required":true,"description":"Search keywords, e.g. a crate name or topic"},{"name":"sort","type":"string","description":"Sort order. relevance=Relevance, downloads=All-Time Downloads, recent-downloads=Recent Downloads, recent-updates=Recent Updates, new=Newly Added","oneOf":["relevance","downloads","recent-downloads","recent-updates","new"]},{"name":"paginate","type":"string","description":"Opaque base64 page token taken from the page's 'Next Page' link (/releases/search?paginate=...). When set, it replaces query and sort."}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/search-crates?query=serde&sort=downloads"},{"command":"resolve-crate","summary":"I'm Feeling Lucky: jump to the best-matching crate for a query and return its exact name and latest version","params":[{"name":"query","type":"string","required":true,"description":"Crate name or keywords"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/resolve-crate?query=reqwest"},{"command":"get-crate","summary":"Get a crate's docs.rs overview page: title, description, documentation link and coverage","params":[{"name":"name","type":"string","required":true,"description":"Crate name as published on crates.io"},{"name":"version","type":"string","description":"Exact version (e.g. 1.0.229), a semver requirement, or 'latest'","default":"latest"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/get-crate"},{"command":"get-crate-status","summary":"Check whether docs built successfully for a crate version (JSON: doc_status, resolved version)","params":[{"name":"name","type":"string","required":true,"description":"Crate name"},{"name":"version","type":"string","description":"Exact version, semver requirement, or 'latest'","default":"latest"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/get-crate-status"},{"command":"list-crate-builds","summary":"List the docs build history of a crate version: rustc version, date, duration, memory, result","params":[{"name":"name","type":"string","required":true,"description":"Crate name"},{"name":"version","type":"string","description":"Exact version or 'latest'","default":"latest"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-crate-builds"},{"command":"list-crate-features","summary":"List the Cargo feature flags of a crate version","params":[{"name":"name","type":"string","required":true,"description":"Crate name"},{"name":"version","type":"string","description":"Exact version or 'latest'","default":"latest"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-crate-features"},{"command":"list-crate-versions","summary":"List all published versions of a crate with their release dates","params":[{"name":"name","type":"string","required":true,"description":"Crate name"},{"name":"version","type":"string","description":"Reference version, normally 'latest'","default":"latest"},{"name":"target","type":"string","description":"Platform target triple","default":"x86_64-unknown-linux-gnu"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-crate-versions"},{"command":"list-source-files","summary":"List the files and folders in a crate's published source package (root or a subfolder)","params":[{"name":"name","type":"string","required":true,"description":"Crate name"},{"name":"version","type":"string","description":"Exact version or 'latest'","default":"latest"},{"name":"dir","type":"string","description":"Folder path ending with '/', e.g. 'src/'. Empty means the package root."}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-source-files"},{"command":"get-source-file","summary":"Read the contents of one file in a crate's source package, e.g. Cargo.toml or src/lib.rs","params":[{"name":"name","type":"string","required":true,"description":"Crate name"},{"name":"version","type":"string","description":"Exact version or 'latest'","default":"latest"},{"name":"path","type":"string","required":true,"description":"File path inside the package, e.g. Cargo.toml or src/lib.rs"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/get-source-file"},{"command":"get-crate-docs","summary":"Read a crate's rustdoc landing page: crate docs text, version, permalink","params":[{"name":"name","type":"string","required":true,"description":"Crate (package) name"},{"name":"version","type":"string","description":"Exact version or 'latest'","default":"latest"},{"name":"crate","type":"string","required":true,"description":"Library name as used in Rust code (dashes become underscores), usually the same as the package name"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/get-crate-docs"},{"command":"list-crate-items","summary":"List every public item (structs, enums, traits, functions, types, constants) of a crate, with links to their doc pages","params":[{"name":"name","type":"string","required":true,"description":"Crate (package) name"},{"name":"version","type":"string","description":"Exact version or 'latest'","default":"latest"},{"name":"crate","type":"string","required":true,"description":"Library name (dashes become underscores)"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-crate-items"},{"command":"get-doc-item","summary":"Read the rustdoc page of one item (struct, trait, fn...) inside a crate","params":[{"name":"name","type":"string","required":true,"description":"Crate (package) name"},{"name":"version","type":"string","description":"Exact version or 'latest'","default":"latest"},{"name":"crate","type":"string","required":true,"description":"Library name (dashes become underscores)"},{"name":"item_path","type":"string","required":true,"description":"Item page path relative to the crate root, as given by list-crate-items href, e.g. task/struct.JoinHandle.html"}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/get-doc-item"},{"command":"list-releases","summary":"Browse docs.rs release listings: recent releases, top crates by GitHub stars, recent build failures, or failures sorted by stars","params":[{"name":"kind","type":"string","description":"Listing type: recent=newest releases, stars=crates with most stars, recent-failures=latest failed builds, failures=most-starred crates that failed to build","oneOf":["recent","stars","recent-failures","failures"],"default":"recent"},{"name":"page","type":"number","description":"Page number starting at 1 (30 items per page)","default":1}],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-releases"},{"command":"get-releases-feed","summary":"Get the Atom feed of the most recently built crate releases (structured JSON)","params":[],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/get-releases-feed"},{"command":"list-build-queue","summary":"List the crate releases waiting in the docs.rs build queue","params":[],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-build-queue"},{"command":"list-builds-in-progress","summary":"List the crate docs builds currently running and how long they have been running","params":[],"exampleUrl":"https://clify-dev.netlify.app/docs-rs/list-builds-in-progress"}]}