Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mohameodo/nano/llms.txt

Use this file to discover all available pages before exploring further.

The shiopa CLI is the official command-line companion for nano. It handles everything from cloning the repository to configuring your site, installing encrypted stream sources (.rink files), and keeping your installation up to date — all without requiring you to touch any source code directly.

​
Installation

The CLI ships as the shiopa binary inside the shiopa-nano npm package. You can install it globally, run it one-off with npx, or invoke it through pnpm after cloning the repo. 
npm install -g shiopa-nano
The shiopa binary is defined in package.json under bin.shiopa, pointing to ./scripts/shiopa.mjs. When you install shiopa-nano globally, shiopa becomes available everywhere in your terminal.

​
How it works

Under the hood, shiopa is a pure Node.js ESM script (scripts/shiopa.mjs) with no external runtime dependencies beyond what ships with Node. It performs three main categories of work:
  • Catalog management — reads and writes .rink scraper plugin files from src/shade/catalog/ (the encrypted source catalog) and copies them into src/shade/private/ (your active sources)
  • Configuration — reads and writes your .env file through an interactive prompt, and can also patch config.shiopa.ts to register new video servers
  • Project lifecycle — wraps git and pnpm to clone the repo, pull updates, and install dependencies
Source names are matched case-insensitively with -/_ normalization, so rink-d14, rink_d14, and RINK-D14 all resolve to the same catalog entry.

​
Typical workflow

Follow these steps to go from nothing to a running nano instance.
1

Clone the nano repository

Run shiopa clone from any directory. This clones https://github.com/mohameodo/nano.git into a new shiopa-nano folder, copies .env.example to .env, and runs pnpm install automatically.
shiopa clone
You can also pass a custom folder name:
shiopa clone my-streaming-site
2

Enter the project directory

cd shiopa-nano
3

Configure your site

Run the interactive config prompt to set your site name, theme, default video server, and more. All answers are written to .env.
shiopa config
Prefer editing files directly? Use --open to open config.shiopa.ts and .env in your editor:
shiopa config --open
4

Install stream sources

Add a single source by name, or install every bundled source at once with --all.
# Install a specific source
shiopa add rei

# Install all bundled sources
shiopa add --all
5

Start the development server

pnpm dev

​
Quick reference

shiopa clone

Clone the nano repo to a local directory and bootstrap your project with a single command.

shiopa config

Run an interactive prompt to set site name, theme, video server, auth, and other .env settings.

shiopa add

Install one or all encrypted .rink stream source plugins into your project.

shiopa list

List every source available in the catalog, with friendly display names.

shiopa update

Pull the latest code from origin/main and reinstall dependencies.

shiopa version

Print the CLI version and the version of the project in the current directory.

Build docs developers (and LLMs) love

Get started for freeTalk to us