Publishing chips

Publishing chips

Publishing a chip on GitHub

Publishing means putting your chip on GitHub (a website that holds code) so any Navi can find and install it. The export builds the whole package — you never copy files by hand:

1. Forge the chip in Chip Studio first.
2. Open Chips → Navi User Repo (NUR) → Local Chips and find your chip — installed chips under Installed, your own makes under Forged.
3. Type a version like 0.1.0 (a version is just a label: this is the first one) and press Export for GitHub, then download the ZIP (one file holding many files).
4. On GitHub, make a new public repository (one project's folder on GitHub; public means everyone can see it) and unzip the export at its top.
5. On the repo page, open the About gear and add the topic navi-chips — a topic is a label, and this label is how Navi finds chips.
6. Publish a release (GitHub's way of saying: this exact version, ready to download) — the version tag is created with that publish, so tag it with the same version. That last step is yours only on the ZIP route: Publish to GitHub (below) publishes the release for you.

Signed in to GitHub? Skip the ZIP: Publish to GitHub on the chip's card does the whole chain for you — it creates the public repo (an existing one is updated, and she says so), sets the navi-chips topic on its own, uploads the same files the export builds, then tags the release from the version in the manifest and publishes it — nothing is left to do on GitHub. An existing version is refused before anything uploads, so bump the version and publish again. The repo name is pre-filled from the chip's name and yours to edit before anything uploads. And the README page is yours too: Edit README on the chip's card edits the generated page; your text is kept inside the chip and ships in the export and the upload alike, with a restore back to the generated page.

Inside the export: root.py and the helper files at the top (install downloads every Python file at the repo root — root.py, or the entry named in the manifest, is the chip; the rest are its modules); navi-chip.json, a small card with the name, description, version, and entry file; the chip .png; and a generated README.md page. Installs and updates: Navi User Repo (NUR) searches GitHub for the navi-chips topic; Install brings the whole file set down as a chip; a release with a bigger tag offers every install an update. Knowledge packs publish the same way — see the RAG page.