Quick start

Get a running instance and evaluate a tool call. About five minutes.

1. Install

npm install @goodciso/aware

That installs version 2.12.3 — the version these docs describe.

2. Set the credential pepper

AWARE stores credentials as salted, peppered hashes. The service refuses to start without a pepper, which is the correct behaviour for a system that holds credentials.

export AWARE_CREDENTIAL_PEPPER="a-long-random-string"
# or, equivalently:
export SECRET_KEY="a-long-random-string"

3. Start the service

npm start

The entrypoint is src/api/index.js. The v2 gateway, coordinator and training components are separate processes with their own Dockerfiles.

4. Confirm it is alive

curl -s localhost:3000/api/health

5. Evaluate a tool call

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

With no matching policy, a tool whose risk is HIGH or CRITICAL is denied. That is the default-deny posture, and it is the behaviour you want.

Next