Documentation Index
Fetch the complete documentation index at: https://mintlify.com/SGizek/Raiku/llms.txt
Use this file to discover all available pages before exploring further.
raiku install is the primary way to add a package to your local Raiku cache. For remote packages it looks up the package in ~/.raiku/index.json, resolves its transitive dependencies, fetches only the required files (not a full repository clone) with real byte-level progress bars, validates both manifests against the schema, verifies the SHA-256 hash of raiku.toml, caches everything under ~/.raiku/cache/<Language>/<name>/<version>/, and finally runs the package’s build command — prompting you for approval in safe mode. You can also point raiku install at a local directory path to install a package from disk without touching the network.
Usage
Flags
| Flag | Short | Description |
|---|---|---|
--trust | Skip the interactive build command confirmation prompt | |
--no-build | Download and cache the package only; do not run build_command | |
--force | -f | Reinstall even if the package is already present in the cache |
--no-deps | Skip transitive dependency resolution and installation | |
--lock | Write or update raiku.lock in the current working directory |
Remote Install Flow
Every remote installation follows these nine steps in order:- Load index — Read
~/.raiku/index.jsonand locate the package entry. - Resolve dependencies — Walk the dependency graph and collect transitive dependencies. Each dependency is installed first, in topological order. Skipped when
--no-depsis set. - Fetch files — Download
raiku.toml,version.yml, andREADME.mdfrom theraw_base_urlconfigured in~/.raiku/config.toml. Real-time progress bars show bytes downloaded, transfer speed, and estimated time remaining. - Schema validation — Parse and validate both
raiku.tomlandversion.ymlagainst the Raiku manifest schema, ensuring all required fields are present and correctly typed. - Hash verification — Compute the SHA-256 hash of the downloaded
raiku.tomland compare it against the value declared in the index entry. A mismatch aborts the install with a security alert. - Cache — Store all fetched files at
~/.raiku/cache/<Language>/<name>/<version>/. - Safe-mode prompt — Display the
build_commanddeclared inraiku.tomland ask for confirmation before running it, unless the package is already in the trusted list or--trustis passed. - Build — Execute the build command in a restricted subprocess inside the package’s cache directory, with a 300-second timeout.
- Lock file — If
--lockis set, add the resolved package entry toraiku.lockin the current directory.
Local Install
When thePACKAGE argument starts with ./, .\\, or resolves to an existing directory path, Raiku performs a local install:
- Validates
raiku.tomlandversion.ymlin the target directory against the schema. - Runs the rules checker to catch forbidden file types and dangerous build command patterns.
- Copies the manifest files into the cache at the appropriate path.
- Runs the build command (subject to the same safe-mode prompt and
--no-buildflag). - Does not require a network connection or an index entry.
Examples
Safe mode is enabled by default (
safe_mode = true in ~/.raiku/config.toml). When active, Raiku always shows the build_command and asks for confirmation before executing it. You can permanently trust a package with raiku trust add <package> to skip the prompt on future installs.