User guide
Armory
The Armory is where you browse, install, and manage .shuriken packages.
What is the Armory?
The Armory displays distributable shuriken packages with metadata including:
- Name, ID, and version
- Platform compatibility
- Synopsis and description
- Authors and license
- Post-install scripts
Installing Packages
Via GUI
- Click Install local file
- Select a
.shurikenfile - Review metadata preview
- Confirm installation
Via CLI
shurikenctl install path/to/package.shurikenInstallation Process
When you install a .shuriken package, Ninja:
- Validates the magic bytes (
HSRZEG) - Reads CBOR-encoded metadata
- Verifies SHA-256 signature
- Extracts tar.gz archive to
~/.ninja/shurikens/{name}/ - Runs post-install script if specified
Package Format
.shuriken files contain:
[MAGIC] 6 bytes - "HSRZEG"
[metadata_length] 2 bytes - u16 little-endian
[metadata] N bytes - CBOR-encoded
[archive_length] 4 bytes - u32 little-endian
[archive] N bytes - tar.gz
[signature] 32 bytes - SHA-256Managing Packages
View Installed
shurikenctl listUninstall
shurikenctl remove {name}Upgrade
Install a newer version with the same ID:
shurikenctl install path/to/package-v2.shurikenCreating Packages
Build distributable packages with the forge command:
shurikenctl forgeThis creates a .shuriken file in the blacksmith/ directory with:
- CBOR metadata
- Compressed archive
- SHA-256 signature
See Developer Guide for packaging details.
Platform Compatibility
Packages specify target platforms:
linux-x86_64windows-x86_64macos-aarch64any(platform-independent)
Ninja validates platform compatibility during installation.
See also: CLI Reference, Configuration Format