DocumentationAgent Action Firewall
GitHub

Installation Guide

Get Agent Action Firewall up and running in minutes. Choose the installation method that best fits your needs.

Prerequisites

System Requirements

  • Node.js: v20 or higher
  • pnpm: v8 or higher
  • Docker: v20 or higher (optional)

Required Services

  • Supabase Account: For database and authentication
  • API Key: Generated from the dashboard

Quick Start (Cloud-Hosted)

The easiest way to get started is using our cloud-hosted service:

  1. Sign up at agentactionfirewall.com/signup
  2. Create your organization
  3. Generate an API key from Settings > API Keys
  4. Install the SDK in your project
Bash
npm install @agent-action-firewall/sdk

TypeScript SDK Installation

Install the Package

Bash
# npm
npm install @agent-action-firewall/sdk

# pnpm
pnpm add @agent-action-firewall/sdk

# yarn
yarn add @agent-action-firewall/sdk

Initialize the Client

TypeScript
import { AgentFirewallClient } from '@agent-action-firewall/sdk';

const client = new AgentFirewallClient({
  baseUrl: 'https://api.agentactionfirewall.com',
  apiKey: process.env.AGENT_FIREWALL_API_KEY!,
  agentId: 'my-ai-agent',
});

Submit Your First Action

TypeScript
// Submit an action for policy evaluation
const response = await client.submitAction({
  tool: 'http_proxy',
  operation: 'POST',
  params: {
    url: 'https://api.example.com/data',
    body: { key: 'value' },
  },
});

if (response.status === 'allowed') {
  console.log('Action allowed, proceed with execution');
} else if (response.status === 'pending_approval') {
  // Wait for human approval
  const finalStatus = await client.waitForApproval(response.id);
  console.log('Approval result:', finalStatus.status);
} else if (response.status === 'denied') {
  console.log('Action denied:', response.decision?.reason);
}

Environment Configuration

Required Variables

Bash
# API Configuration
AGENT_FIREWALL_API_KEY=your-api-key
AGENT_FIREWALL_BASE_URL=https://api.agentactionfirewall.com

# Agent Identification
AGENT_ID=my-agent-name

Verification

Test Your Setup

TypeScript
import { AgentFirewallClient } from '@agent-action-firewall/sdk';

const client = new AgentFirewallClient({
  baseUrl: process.env.AGENT_FIREWALL_BASE_URL!,
  apiKey: process.env.AGENT_FIREWALL_API_KEY!,
  agentId: 'test-agent',
});

// Submit a test action
const response = await client.submitAction({
  tool: 'test',
  operation: 'ping',
  params: {},
});

console.log('Test action response:', response);

Next Steps