faramesh.devBETA
docsgithubcommunityget started →

docs

Getting Started

Core

FPL

Governance

Operations

Reference

github ↗slack ↗community ↗

02 , quickstart

Copy, paste, running.

Follow these steps in order. By the end you will have Faramesh installed and a governed agent running.

1. Install

Pick any method. curl is the fastest.

bash
curl -fsSL https://raw.githubusercontent.com/faramesh/faramesh-core/main/install.sh | bash

Or use Homebrew:

bash
brew install faramesh/tap/faramesh

Confirm the binary is working.

bash
faramesh --version

2. Create a policy file

Save this as policy.fpl. It blocks destructive shell commands and defers large refunds for human review.

policy.fplfpl
agent quickstart-agent {
  default permit

  rules {
    deny! shell/run
      when cmd matches "rm -rf"
      reason: "destructive command blocked"

    defer stripe/refund
      when amount > 500
      notify: "finance-team"
  }
}

3. Validate

Always check the policy for errors before running.

bash
faramesh policy validate policy.fpl

4. Run your agent under Faramesh

Prepend faramesh run to your normal agent command. Faramesh auto-detects the framework, loads the policy, strips credentials, and starts governing.

bash
faramesh run --policy policy.fpl -- python agent.py

5. Watch decisions live

Open a second terminal and watch verdicts as they happen.

bash
faramesh audit tail

6. Handle deferred actions

Approve or deny actions paused by a defer rule.

bash
faramesh agent approve <defer-token>
bash
faramesh agent deny <defer-token>

Need help? Use any of these support options.

open an issuejoin slackcommunity/forum
MIT License
docsgithubcommunityget started →