Quickstart

This quickstart takes an empty BRAIAN workspace to a governed process running in the sandbox environment. You will authenticate, connect one system, define a process and an agent, attach an approval policy, run the process and read the resulting audit entries. It takes roughly thirty minutes.

View as markdown

1. Authenticate and select an environment

The command line authenticates through your organisation's identity provider and stores a short-lived session bound to one environment.

bash

braian login --org acme
braian env use sandbox

2. Connect a system

Connections are created in the control plane and are scoped per environment. In sandbox, connect a read-only account so a mistake cannot reach live records.

bash

braian connection create sap \
  --scopes purchase_orders.read,invoices.read \
  --env sandbox

3. Define an agent and a process

Save the two definitions as files and apply them. Applying validates the tool scopes against the connection you created.

bash

braian apply -f finance-agent.yaml
braian apply -f invoice-approval.yaml

4. Attach a policy and run

Attach an approval threshold before the first run, then trigger the process with a sample payload.

bash

braian apply -f finance.payment-threshold.yaml
braian process run invoice-approval --input ./sample-invoice.json

5. Read what happened

Open the run in the console or inspect it from the command line. Every step shows the agent, the policy decision and the elapsed time.

bash

braian run show --last
braian audit export --run last --format json