Metadata-Version: 2.5
Name: cann-recipes-cli
Version: 0.1.0
Summary: Search the CANN recipes repositories (infer/train/...): models, modules, ops, docs in one offline FTS5 index
Author: cann-recipes-cli 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: ascend,cann,cli,documentation,inference,llm,npu,recipes
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 :: Utilities
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Description-Content-Type: text/markdown

# cann-recipes-cli

One offline index over the CANN recipes repositories — [cann-recipes-infer](https://gitcode.com/cann/cann-recipes-infer), [cann-recipes-train](https://gitcode.com/cann/cann-recipes-train), [cann-recipes-harmony-infer](https://gitcode.com/cann/cann-recipes-harmony-infer), [cann-recipes-embodied-ai](https://gitcode.com/cann/cann-recipes-embodied-ai), [cann-recipes-spatial-intelligence](https://gitcode.com/cann/cann-recipes-spatial-intelligence) — so one query answers: *which model is optimized where, for which hardware, and how?*

- `search` — full-text across models / modules / ops / docs / integrations
- category, repo, and hardware filters (`--category model --hw A3`)
- `read` — read any indexed page
- `init` — shallow-clone the recipe repos and build the index

## Install

```bash
pip install cann-recipes-cli
```

## Quick start

```bash
cann-recipes init                       # clone all five repos (shallow) + index
cann-recipes init --repo infer          # just the inference recipes
cann-recipes search GLM-5               # where is GLM-5 optimized?
cann-recipes search 量化 --category module
cann-recipes search moe --hw A3         # hardware filter
cann-recipes read infer/models/glm_5/README.md
```

Already have clones? `cann-recipes --root /path/to/parent ...` or set `CANN_RECIPES_ROOT`. Indexes rebuild automatically when any repo HEAD changes.

This project contains the query client only. Content comes from the recipes repositories at runtime and follows their own license terms.

## License

MIT
