Metadata-Version: 2.5
Name: asc-devkit-docs-cli
Version: 0.1.0
Summary: Query the Ascend asc-devkit repository: FTS5 docs search plus source code lookup
Author: asc-devkit-docs contributors
License: MIT License
        
        Copyright (c) 2026 asc-devkit-docs contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: asc-devkit,ascend,ascendc,cann,cli,documentation,npu
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Description-Content-Type: text/markdown

# asc-devkit-docs-cli

Query the [Ascend asc-devkit](https://gitcode.com/cann/asc-devkit) repository from the command line: full-text documentation search (FTS5) plus source code symbol lookup, in one tool.

- `search` / `api` / `section` — docs under `docs/api` + `docs/guide` (about 3,000 markdown files)
- `code` / `read` — symbol lookup in `include/` `impl/` `examples/` (ripgrep-based)
- `whereis` — full picture of one symbol: doc page + declaration + implementations (per-arch variants) + examples
- `init` — detect the locally installed CANN version, clone the matching asc-devkit branch, build the index

## Install

```bash
pip install asc-devkit-docs-cli
```

Requires Python >= 3.10 and [ripgrep](https://github.com/BurntSushi/ripgrep) for code queries.

## Quick start

```bash
devkit-docs init                     # detect CANN, clone matching branch, index docs
devkit-docs api GatherMask           # doc page first; falls back to code declarations
devkit-docs code GatherMask          # decl + impl (dav_* variants) + examples
devkit-docs whereis GatherMask       # everything at once
devkit-docs search 双缓冲             # full-text over api + guide docs
```

No local CANN? `devkit-docs init --cann-version 9.1.0`.

This project contains the query client only. Documentation, source code, and indexes come from the asc-devkit repository at runtime and follow its own license terms.

## License

MIT
