Skip to content

configuration.md

Latest commit

 

History

History
112 lines (75 loc) · 2.08 KB

configuration.md

File metadata and controls

112 lines (75 loc) · 2.08 KB

Configuration

Terminal uses a configuration object to define security policies. All settings are optional and merge with sensible defaults.

Basic Configuration

Terminal.initialize({
  workspaces: ['/safe/project'],
  commands: {
    allow: ['cd *', 'node *', 'deno *'],
    deny: ['rm *', 'sudo *'],
    maxArgs: 10,
    strictArgs: true,
    noShell: true
  },
  env: {
    allow: ['NODE_ENV', 'PATH'],
    deny: ['HOME', 'SSH_*']
  },
  timeout: 30000
})

Workspaces

Restrict command execution to specific directories:

workspaces: ['/home/user/projects', '/tmp/builds']

Commands outside these paths will be rejected.

Commands

allow - Command Whitelist

Pattern-based allowlist. Empty array allows all (unless denied).

allow: ['git *', 'npm *', 'node *.js', 'deno run *']

deny - Command Blacklist

Pattern-based denylist. Always checked first.

deny: ['rm -rf *', 'sudo *', 'mkfs.*', 'dd *']

maxArgs - Argument Limit

Maximum number of arguments allowed per command.

maxArgs: 10 // Rejects commands with more than 10 arguments

strictArgs - Strict Validation

Block shell metacharacters in arguments:

strictArgs: true // Blocks ; | & ` $ ( ) { } [ ] < >

noShell - Shell Control

noShell: true // Always use direct execution (recommended)

Environment Variables

allow - Variable Whitelist

allow: ['NODE_ENV', 'PATH', 'HOME']

deny - Variable Blacklist

Supports wildcards:

deny: ['SSH_*', 'AWS_*', 'TOKEN*']

Timeout

Default timeout in milliseconds:

timeout: 30000 // 30 seconds

Set to 0 to disable timeouts.

Pattern Syntax

Patterns use token matching with optional wildcards:

  • git * - Matches "git" followed by any arguments
  • node *.js - Matches "node" with .js file argument
  • deno run * - Matches exact prefix, allows suffix

See Also