Installation

SentriFlow is available as a command-line interface (CLI) for automation and CI/CD pipelines, and as a VS Code extension for real-time validation in your editor.

System Requirements

Before installing SentriFlow, ensure your system meets these requirements:

CLI Installation

The SentriFlow CLI (@sentriflow/cli) provides command-line validation for scripts, CI/CD pipelines, and batch processing.

Package Managers

Install the CLI globally using your preferred package manager:

npm install -g @sentriflow/cli

yarn global add @sentriflow/cli

pnpm add -g @sentriflow/cli

bun install -g @sentriflow/cli

Verify Installation

After installation, verify the CLI is working correctly:

sentriflow --version

You should see output similar to:

sentriflow/0.4.1

Local Project Installation

For project-specific installations (recommended for CI/CD), install as a dev dependency:

npm install -D @sentriflow/cli

yarn add -D @sentriflow/cli

pnpm add -D @sentriflow/cli

bun add -d @sentriflow/cli

Then run via npx or your package manager:

npx sentriflow router.conf

VS Code Extension

The SentriFlow VS Code extension provides real-time validation as you edit network configurations.

From Marketplace

Command Line Installation

You can also install the extension via the command line:

code --install-extension sentriflow.sentriflow-vscode

Manual Installation (VSIX)

For air-gapped environments or when you need a specific version, install from a VSIX file:

code --install-extension sentriflow-vscode-0.5.3.vsix

Verify VS Code Extension

After installation:

1. Open any .conf, .cfg, .ios, or .junos file
2. Look for the SentriFlow icon in the Activity Bar
3. Check the status bar for the SentriFlow status indicator

You should see the SentriFlow panel with:

• Rules - Available validation rules organized by pack and vendor
• IP Addresses - Extracted IP addresses from the current file
• License - License status (Community tier by default)
• Settings - Configuration options

Supported File Types

SentriFlow automatically activates for files with these extensions:

For other file types, set the language mode to “Network Config” via the Command Palette or status bar.

Troubleshooting

CLI Issues

Command not found after installation

If sentriflow is not found, ensure your global npm/yarn/pnpm bin directory is in your PATH:

# npm
npm config get prefix
# Add <prefix>/bin to PATH
 
# yarn
yarn global bin
# Add output directory to PATH
 
# pnpm
pnpm config get global-bin-dir
# Add output directory to PATH

Permission errors on Linux/macOS

If you encounter EACCES permission errors:

# Option 1: Use a Node version manager (recommended)
# Install nvm, fnm, or volta
 
# Option 2: Change npm prefix (not recommended for beginners)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

VS Code Extension Issues

Extension not activating

1. Ensure the file has a supported extension (.conf, .cfg, .ios, .junos)
2. Or manually set the language: Press Ctrl+K M and select “Network Config”
3. Check the Output panel (View > Output > SentriFlow) for error messages

Extension conflicts

If you have other network configuration extensions installed, they may conflict. Try disabling other extensions temporarily to isolate the issue.

Next Steps

Now that SentriFlow is installed, continue to:

• Quick Start - Validate your first configuration
• VS Code Setup - Configure the VS Code extension
• CLI Commands - Learn all CLI options