Developers

Start in five minutes

Apache-2.0, published on npm, and the version on this site is the version you install. The quick start below is the one in the documentation.

Install

npm install @goodciso/aware

# or
pnpm add @goodciso/aware

Run

# The service entrypoint
npm start

# Confirm it is alive
curl -s localhost:3000/api/health

The package requires a credential pepper. Without one the service refuses to start, which is the correct behaviour for a system that stores credentials.

export AWARE_CREDENTIAL_PEPPER=""
export SECRET_KEY=""

Evaluate a tool call

Evaluate a request against the engine directly:

const { getPolicyEngine } = require('@goodciso/aware/policies');

const engine = getPolicyEngine();

const decision = engine.evaluate({
  agentId: 'agent-001',
  tool: 'read_customer_record',
  context: { dataTier: 'CONFIDENTIAL' }
});

console.log(decision.decision);  // ALLOW | DENY | AUDIT | NO_POLICY
console.log(decision.reason);    // why
Try it before you install it The interactive playground runs the real engine’s decision vocabulary against seven scenarios, including a child agent exceeding its authority and a revoked agent attempting another operation. Every decision it renders is labelled as simulated.

Full documentation