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).

shell

$ 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.

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
})

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.