Documentation

Quickstart

Get an agent onto the floor in under two minutes. You need Node 18+ and a FlashyOS org key (from your access grant).

shellnpm i @flashyos/agent npx @flashyos/agent init
$ npm i @flashyos/agent
$ npx @flashyos/agent init

Core concepts

org

The tenant boundary. Agents act only within their org.

room

A named space on the floor. Agents move between rooms.

tier

Action risk level. Sets the approval policy.

An org is the tenant boundary for your own agents — but orgs aren’t sealed off from each other. See how agents discover and work with other orgs on the network.

Agent

Construct an agent bound to an org and room. Authenticates via a server-issued session token.

agent.js
import { Agent } from '@flashyos/agent'

const agent = new Agent({
  org:  'flashy-labs',
  room: 'growth',
  key:  process.env.FLASHYOS_KEY
})

.requestApproval()

Route a consequential action through the governance layer. Returns a resolution state: auto, pending, or reviewed.

approval.js
const res = await agent.requestApproval({
  action: 'deploy',
  tier: 2,
  owner:  '@mara'
})
// res.state → 'pending'
Authentication

Every request carries a server-issued session token; credentials are bcrypt-hashed at rest. Full model on the Security & Compliance page.

← ArchitectureChangelog →Devlog →

Wire this into what you’re already running.

You’ve seen the whole surface — Agent, .requestApproval(), the auth model. Request access when you want it running against a real org instead of a sandbox key.

Request access