Skip to content

Commit d557de0

Browse files
barckcodeclaude
andcommitted
Update README with install methods and agent skill setup
Add agent skill installation (npx skills add), curl installer, Homebrew tap, and go install as the first section so users can get started quickly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 68923e3 commit d557de0

File tree

1 file changed

+37
-22
lines changed

1 file changed

+37
-22
lines changed

README.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,41 @@ A command-line tool for AWS cloud cost analysis and optimization. Scans your AWS
44

55
**Local-first design** — your data stays on your machine. Reports never call cloud APIs.
66

7-
## Features
7+
## Install
88

9-
- **Multi-account support** — auto-detects AWS Organizations, scans all linked accounts
10-
- **Cost analysis** — monthly spend breakdown by service, region, and account
11-
- **Resource discovery** — finds EC2, RDS, S3, Lambda, ECS/EKS, ElastiCache, NAT Gateways, CloudFront distributions
12-
- **Anomaly detection** — statistical z-score analysis to flag cost spikes
13-
- **Period comparison** — side-by-side cost comparison between any two periods
14-
- **Commitment tracking** — Savings Plans and Reserved Instances utilization and coverage
15-
- **Rich reports** — HTML with embedded charts (Chart.js), CSV, JSON, and PDF output
16-
- **Incremental sync** — only fetches new data on subsequent runs
17-
- **Zero CGO** — pure Go binary, cross-compiles to Linux, macOS, and Windows
9+
### Agent Skill
10+
11+
Add the FinOps skill to your AI agent (Claude Code, or any [skills.sh](https://skills.sh)-compatible agent):
12+
13+
```bash
14+
npx skills add helmcode/finops-cli
15+
```
1816

19-
## Installation
17+
This gives your agent the knowledge to use the FinOps CLI effectively — cost analysis, anomaly detection, report generation, and more.
2018

21-
### From GitHub Releases (recommended)
19+
### CLI
2220

23-
Download the latest binary for your platform from [Releases](https://github.com/helmcode/finops-cli/releases):
21+
#### Quick install (Linux / macOS)
2422

2523
```bash
26-
# macOS (Apple Silicon)
27-
curl -Lo finops.tar.gz https://github.com/helmcode/finops-cli/releases/latest/download/finops-cli_$(curl -s https://api.github.com/repos/helmcode/finops-cli/releases/latest | grep tag_name | cut -d'"' -f4 | sed 's/v//')_darwin_arm64.tar.gz
28-
tar xzf finops.tar.gz
29-
sudo mv finops /usr/local/bin/
24+
curl -fsSL https://raw.githubusercontent.com/helmcode/finops-cli/main/install.sh | sh
25+
```
3026

31-
# macOS (Intel)
32-
# Replace darwin_arm64 with darwin_amd64
27+
The script auto-detects your OS and architecture, downloads the correct binary, verifies the SHA256 checksum, and installs it.
3328

34-
# Linux (amd64)
35-
# Replace darwin_arm64 with linux_amd64
29+
#### Homebrew (macOS / Linux)
30+
31+
```bash
32+
brew install helmcode/tap/finops-cli
3633
```
3734

38-
### From source
35+
#### Go install
36+
37+
```bash
38+
go install github.com/helmcode/finops-cli@latest
39+
```
40+
41+
#### From source
3942

4043
Requires Go 1.25+:
4144

@@ -46,6 +49,18 @@ make build
4649
# Binary at ./bin/finops
4750
```
4851

52+
## Features
53+
54+
- **Multi-account support** — auto-detects AWS Organizations, scans all linked accounts
55+
- **Cost analysis** — monthly spend breakdown by service, region, and account
56+
- **Resource discovery** — finds EC2, RDS, S3, Lambda, ECS/EKS, ElastiCache, NAT Gateways, CloudFront distributions
57+
- **Anomaly detection** — statistical z-score analysis to flag cost spikes
58+
- **Period comparison** — side-by-side cost comparison between any two periods
59+
- **Commitment tracking** — Savings Plans and Reserved Instances utilization and coverage
60+
- **Rich reports** — HTML with embedded charts (Chart.js), CSV, JSON, and PDF output
61+
- **Incremental sync** — only fetches new data on subsequent runs
62+
- **Zero CGO** — pure Go binary, cross-compiles to Linux, macOS, and Windows
63+
4964
## Quick Start
5065

5166
### 1. Configure AWS credentials

0 commit comments

Comments
 (0)