o# @fire-shield/cli

Command-line interface for Fire Shield RBAC.

Installation

# npm
npm install -g @fire-shield/cli

# yarn
yarn global add @fire-shield/cli

# pnpm
pnpm add -g @fire-shield/cli

Usage

Validate Configuration

Validate an RBAC configuration file:

fire-shield validate ./fire-shield.config.json

With options:

fire-shield validate ./config.json --strict --verbose

Options:

• -s, --strict - Enable strict mode validation
• -v, --verbose - Show detailed validation output

Check Permission

Check if a user has a specific permission:

fire-shield check ./config.json \
  --user john123 \
  --roles admin editor \
  --permission user:write

Options:

• -u, --user <userId> - User ID to check
• -r, --roles <roles...> - User roles (space-separated)
• -p, --permission <permission> - Permission to check
• -v, --verbose - Show detailed check output

CLI Information

Display CLI information:

fire-shield info

Initialize Configuration (Coming Soon)

Initialize a new Fire Shield configuration:

fire-shield init

Examples

Basic Validation

fire-shield validate ./rbac-config.json

Output:

🔍 Validating RBAC configuration...

✓ Configuration is valid

  Validated in 12ms

Verbose Validation

fire-shield validate ./rbac-config.json --verbose

Output:

🔍 Validating RBAC configuration...

  File: /path/to/rbac-config.json
  Strict mode: disabled

✓ Configuration is valid

  Configuration details:
  • Name: my-rbac
  • Version: 1.0.0
  • Permissions: 10
  • Roles: 4

  Permissions:
    • user:read [bit: 1]
    • user:write [bit: 2]
    • user:delete [bit: 4]
    ...

  Roles:
    • viewer [level: 1]
      Permissions: user:read, post:read
    • editor [level: 5]
      Permissions: user:read, user:write, post:read, post:write
    ...

  Validated in 15ms

Permission Check

fire-shield check ./config.json \
  --user alice \
  --roles editor \
  --permission user:write \
  --verbose

Output:

🔍 Checking permission...

  Config file: /path/to/config.json
  User: alice
  Roles: editor
  Permission: user:write

✓ User has permission "user:write"

  User: alice
  Roles: editor
  Permission: user:write
  Result: ALLOWED
  Granted by: editor

Configuration File Format

Fire Shield CLI expects a JSON configuration file with this structure:

{
  "name": "my-rbac",
  "version": "1.0.0",
  "permissions": [
    { "name": "user:read", "bit": 1 },
    { "name": "user:write", "bit": 2 },
    { "name": "user:delete", "bit": 4 }
  ],
  "roles": [
    {
      "name": "viewer",
      "permissions": ["user:read"],
      "level": 1
    },
    {
      "name": "editor",
      "permissions": ["user:read", "user:write"],
      "level": 5
    }
  ]
}

Exit Codes

• 0 - Success
• 1 - Validation/check failed or error occurred

Performance Optimizations

The Fire Shield CLI (v3.1.0+) automatically enables performance optimizations when validating and checking permissions:

Automatic Optimizations

When you use fire-shield validate or fire-shield check, the CLI automatically:

• ✅ Enables permission caching - 90% faster for repeated checks
• ✅ Enables memory optimization - 40-60% less memory usage in large applications

These optimizations are applied automatically for maximum performance.

Manual RBAC Setup

If you're creating RBAC instances programmatically, you can also enable these optimizations:

import { RBAC } from '@fire-shield/core';

// Create RBAC with optimizations
const rbac = new RBAC({
  preset: config,
  enableCache: true,      // 90% faster for frequent checks
  optimizeMemory: true    // 40-60% less memory in large apps
});

// Or use fromJSONConfig (recommended)
const rbac = RBAC.fromJSONConfig(JSON.stringify(config), {
  useBitSystem: true,
  enableCache: true,
  optimizeMemory: true
});

Benefits

• ⚡ 90% faster permission checks with caching enabled
• 💾 40-60% less memory usage with optimization enabled
• ⚙️ Sub-millisecond checks with bit-based system
• 🚀 Ready for production - Built-in optimizations out of the box

License

DIB © khapu2906