Docs
Everything needed to get a first video out of your codebase. Written so an agent can follow it without a human reading along.
Setup
$ npx niiro init✓ Next.js 16, Tailwind v4, 12 paths proposed✓ niiro.yml written$ npx niiro push✓ 218 files, 0 secrets, encrypted→ report at niiro.io/p/acme-web
- 01Run init in your repo. It detects your framework and styling, proposes the paths to include and writes niiro.yml.
- 02Check the allowlist. Only what stands in include leaves your machine. Everything else is invisible to niiro.
- 03Push. The secret scan runs first and stops on a finding. Only files niiro does not have yet are uploaded.
- 04Open the report in the portal. It names what niiro understood and proposes three videos.
niiro.yml
project: acme-webinclude:- src/components/**- src/app/**- tailwind.config.ts- src/styles/**exclude:- "**/*.test.*"- "**/__mocks__/**"
Commands
- niiro init
- Detects the stack, writes niiro.yml, stores the project token, offers a CI step.
- niiro push
- Filters, scans for secrets, uploads the delta, reports which videos the change affects.
- niiro status
- Last sync, number of stale videos, link into the portal.
- niiro login
- Stores the token in the OS keychain. In CI use NIIRO_TOKEN instead.
Always excluded
Even when a pattern would include them: environment files, node_modules, .git, lockfiles and binaries over 5 MB. The project token is write-only, it can create snapshots but never read code or anything derived from it.
For coding agents
Every page here exists twice: rendered for people and as raw Markdown for agents. Point your agent at the Markdown URL and it can set niiro up on its own.