Skip to content

Zerverless/oz

Repository files navigation

oz — Open Zerverless

npm License: MIT

A CLI for discovering, analyzing, tracing, and explaining serverless AWS accounts. Point it at any AWS account with your own credentials — no Zerverless account required.

$ oz discover
Discovering serverless resources in account 123456789012 (us-east-1)...

  12 Lambda functions
   3 API Gateway APIs
   4 DynamoDB tables
   2 EventBridge buses

Run `oz services` for a breakdown, or `oz explain <resource>` for details.

Install

npm install -g @zerverless/oz
# or run without installing:
npx @zerverless/oz discover

Commands

Command What it does
oz discover Scan the current AWS account/region for serverless resources
oz services List discovered services with a summary
oz costs Basic cost breakdown for discovered resources
oz trace Trace relationships between services (who calls what)
oz logs Read recent, relevant CloudWatch logs
oz explain <resource> Human-readable explanation of a specific resource

Every command supports --output json for scripting, and --output table (default in a TTY). Full docs per command: docs/commands/.

Shell completion

oz completion bash > /etc/bash_completion.d/oz   # or .zsh / .fish, see completions/

How it authenticates

oz uses your existing AWS credential chain (env vars, ~/.aws/credentials, SSO, instance role) — exactly like the AWS CLI. It never talks to any Zerverless service.

Relationship to Zerverless

oz's discovery model conceptually inspires Air's read-only discovery and Hero's AI context gathering — but oz itself has zero dependency on zerverless-platform or any private service, and never will. It's useful entirely on its own.

Contributing

See CONTRIBUTING.md and please read CODE_OF_CONDUCT.md first.

Security

See SECURITY.md.

License

MIT — see LICENSE.

About

Open Zerverless — CLI for serverless AWS discovery

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors