Plugin CLI Reference

# Install globally
npm install -g lokus-plugin-cli
 
# Or use with npx (no installation needed)
npx lokus-plugin <command>

npx lokus-plugin create <plugin-name> [options]

# Interactive mode (prompts for all options)
npx lokus-plugin create my-plugin
 
# Quick start with defaults
npx lokus-plugin create my-plugin --skip-prompts
 
# Specific template
npx lokus-plugin create my-plugin --template react-ui-panel
 
# With metadata
npx lokus-plugin create my-plugin \
  --template basic-typescript \
  --author "John Doe" \
  --description "My awesome plugin" \
  --display-name "My Plugin"

my-plugin/
├── src/
│   └── index.ts          # Plugin entry point
├── test/
│   ├── index.test.ts     # Unit tests
│   └── setup.ts          # Test setup
├── dist/                  # Build output (after npm run build)
├── package.json          # npm configuration
├── plugin.json           # Plugin manifest
├── tsconfig.json         # TypeScript config
├── esbuild.config.js     # Build configuration
└── README.md

npx lokus-plugin build [options]

# Build current directory
npx lokus-plugin build
 
# Build with source maps
npx lokus-plugin build --sourcemap
 
# Watch mode
npx lokus-plugin build --watch
 
# Build specific directory
npx lokus-plugin build --path ./my-plugin

npx lokus-plugin dev [options]

# Start dev mode
npx lokus-plugin dev
 
# With verbose output
npx lokus-plugin dev --verbose
 
# Clean start
npx lokus-plugin dev --clean

npx lokus-plugin validate [options]

✓ Plugin manifest is valid
  Name: my-plugin
  Version: 0.1.0
  Description: A Lokus plugin

Error: Missing required fields: version, main

# Validate current directory
npx lokus-plugin validate
 
# Validate specific plugin
npx lokus-plugin validate --path ./my-plugin

npx lokus-plugin link [options]

# Link current plugin
npx lokus-plugin link
 
# Link specific plugin
npx lokus-plugin link --path ./my-plugin

ls -la ~/.lokus/plugins/
# Should show: my-plugin -> /path/to/your/plugin

rm ~/.lokus/plugins/<plugin-id>

npx lokus-plugin package [options]

# Package current plugin
npx lokus-plugin package
 
# Custom output directory
npx lokus-plugin package --output ./releases

npx lokus-plugin publish [options]

# Publish to production
npx lokus-plugin publish
 
# Dry run (test without publishing)
npx lokus-plugin publish --dry-run
 
# Publish as beta
npx lokus-plugin publish --tag beta

npx lokus-plugin login [options]

# Interactive login
npx lokus-plugin login
 
# With token
npx lokus-plugin login --token lok_xxxxxxxxxxxxxxxx
 
# Using environment variable
export LOKUS_REGISTRY_TOKEN=lok_xxxxxxxxxxxxxxxx
npx lokus-plugin publish

{
  "registryToken": "lok_xxxxxxxxxxxxxxxx"
}

npx lokus-plugin list [options]

Installed Plugins:
  my-plugin (0.1.0) - linked
  other-plugin (1.2.3) - installed

npx lokus-plugin info [plugin-id] [options]

# Info for current plugin
npx lokus-plugin info
 
# Info for specific plugin
npx lokus-plugin info my-plugin

{
  "lokus": {
    "manifest": "./plugin.json",
    "entry": "./src/index.ts",
    "outDir": "./dist"
  }
}

{
  "registry": "https://lokusmd.com",
  "manifest": "./plugin.json"
}

# 1. Create plugin
npx lokus-plugin create my-plugin --template basic-typescript
cd my-plugin
 
# 2. Install dependencies
npm install
 
# 3. Build
npm run build
 
# 4. Validate
npx lokus-plugin validate
 
# 5. Link for development
npx lokus-plugin link
 
# 6. Start Lokus and test your plugin

# 1. Ensure tests pass
npm test
 
# 2. Build production
npm run build
 
# 3. Validate
npx lokus-plugin validate
 
# 4. Update version
npm version patch  # or minor/major
 
# 5. Login (if not already)
npx lokus-plugin login
 
# 6. Publish
npx lokus-plugin publish

# 1. Make changes
# 2. Update version
npm version patch
 
# 3. Build and validate
npm run build
npx lokus-plugin validate
 
# 4. Publish update
npx lokus-plugin publish

# Use npx instead of global install
npx lokus-plugin <command>

ls plugin.json

# Re-login
npx lokus-plugin login
 
# Check token
cat ~/.lokus/config.json

npm version patch