CLI Reference

Complete reference for the trik command-line interface.

Installation

npm install -g @trikhub/cli

Synopsis

trik <command> [options]

Global Options

OptionDescription
--devUse development registry (localhost:3001)
--versionShow version number
--helpShow help

Commands

install

Install a trik from the registry.

trik install <trik> [options] trik i <trik> [options]

Arguments:

ArgumentDescription
trikTrik identifier (e.g., @molefas/article-search)

Options:

OptionDescription
-v, --version <version>Install specific version

Examples:

trik install @molefas/article-search trik i @molefas/article-search -v 2.0.0

uninstall

Remove an installed trik.

trik uninstall <trik> trik rm <trik> trik remove <trik>

Arguments:

ArgumentDescription
trikTrik identifier to remove

Examples:

trik uninstall @molefas/article-search trik rm @acme/weather

list

List installed triks.

trik list [options] trik ls [options]

Options:

OptionDescription
-j, --jsonOutput as JSON

Examples:

trik list trik ls --json

Search the registry for triks.

trik search <query> [options] trik s <query> [options]

Arguments:

ArgumentDescription
querySearch query

Options:

OptionDescription
-j, --jsonOutput as JSON
-l, --limit <number>Limit results (default: 10)

Examples:

trik search weather trik s "article search" -l 5

info

Show detailed information about a trik.

trik info <trik> [options]

Arguments:

ArgumentDescription
trikTrik identifier

Options:

OptionDescription
-j, --jsonOutput as JSON

Examples:

trik info @molefas/article-search trik info @molefas/article-search --json

upgrade

Upgrade installed triks.

trik upgrade [trik] [options] trik up [trik] [options]

Arguments:

ArgumentDescription
trikOptional trik identifier (upgrades all if omitted)

Options:

OptionDescription
-f, --forceForce reinstall even if up to date

Examples:

trik upgrade # Upgrade all trik upgrade @molefas/article-search # Upgrade specific trik up --force # Force reinstall all

sync

Discover triks installed via npm and add to config.

trik sync [options]

Options:

OptionDescription
-n, --dry-runShow what would be synced
-j, --jsonOutput as JSON

Examples:

trik sync trik sync --dry-run

login

Authenticate with GitHub.

trik login

Opens browser for GitHub OAuth authentication. Tokens are stored in:

  • macOS: Keychain
  • Linux: Secret Service
  • Windows: Credential Manager

logout

Remove saved authentication.

trik logout

whoami

Show current authenticated user.

trik whoami

publish

Publish a trik to the registry.

trik publish [options]

Options:

OptionDescription
-d, --directory <path>Trik directory (default: .)
-t, --tag <version>Version tag (default: from manifest)

Examples:

trik publish trik publish -d ./my-trik trik publish -t 1.0.1

Config File

The CLI manages .trikhub/config.json:

{ "triks": [ { "id": "@molefas/article-search", "version": "2.0.0", "path": ".trikhub/triks/@molefas/article-search" } ] }
FieldDescription
idTrik identifier
versionInstalled version
pathLocal path to trik files

Environment Variables

VariableDescription
NODE_ENVSet to development for dev registry
TRIKHUB_REGISTRYCustom registry URL

Exit Codes

CodeDescription
0Success
1General error
2Invalid arguments
3Authentication required
4Trik not found