Skip to content

Commit a76f092

Browse files
committed
fear(cli): improved README with better formatting and additional examples
1 parent afb02dd commit a76f092

1 file changed

Lines changed: 56 additions & 18 deletions

File tree

README.md

Lines changed: 56 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,40 @@
11
# ApiQube CLI
22

3-
**ApiQube** is a powerful, plugin-extensible CLI tool for building, executing, and monitoring tests for modern microservice applications — from simple HTTP APIs to complex multi-container systems.
4-
5-
Part of the [ApiQube](https://github.com/apiqube) ecosystem.
3+
**ApiQube CLI** is a powerful, extensible command-line tool designed for building, executing, and monitoring tests for modern microservice applications—from simple HTTP APIs to complex multi-container systems. It is part of the [ApiQube](https://github.com/apiqube) ecosystem.
64

75
---
86

97
## 🚀 Features
108

11-
- **Plugin architecture** extend Qube with custom actions
12-
- **Test execution engine** — define `use-cases`, test flows, and assertions via YAML
13-
- **Docker-native** spin up containers, stub databases, and environments for each test
14-
- **Plan builder** — build and apply test execution plans (like `kubectl apply`)
15-
- **Load testing support** — stress your services with real use cases
16-
- **Live metric collection**Prometheus integration, metrics agents for Go, JS, Python
17-
- **Future Wails UI** — desktop testing studio with visual flow and live dashboards
18-
- **CI-ready** — easily integrate with GitHub Actions / GitLab CI
19-
- **Interactive CLI** — powered by [Bubbletea](https://github.com/charmbracelet/bubbletea)
9+
- **Plugin Architecture**: Easily extend the CLI with custom plugins and actions.
10+
- **Test Execution Engine**: Define use-cases, test flows, and assertions using YAML manifests.
11+
- **Docker-Native**: Seamlessly spin up containers, stub databases, and create isolated environments for each test.
12+
- **Plan Builder**: Build and apply test execution plans, similar to `kubectl apply`.
13+
- **Load Testing Support**: Stress-test your services with real-world use cases.
14+
- **Live Metric Collection**: Integrates with Prometheus and supports metrics agents for Go, JavaScript, and Python.
15+
- **Future Wails UI**: Desktop testing studio with visual flow editing and live dashboards (coming soon).
16+
- **CI-Ready**: Easily integrates with GitHub Actions and GitLab CI for automated testing.
17+
- **Interactive CLI**: Built with [Bubbletea](https://github.com/charmbracelet/bubbletea) for a modern terminal experience.
2018

2119
---
2220

2321
## 📦 Installation
2422

25-
### Prebuilt (recommended)
23+
### Prebuilt Binaries (Recommended)
2624

27-
TBA via releases or `go-semantic-release`. For now:
25+
Prebuilt releases will be available soon via GitHub Releases and `go-semantic-release`. For now, build from source:
2826

2927
```bash
3028
git clone https://github.com/apiqube/cli.git
3129
cd cli
3230
task build
33-
cp ./bin/qube.exe ~/bin/qube # or any PATH directory
31+
cp ./bin/qube.exe ~/bin/qube # or any directory in your PATH
3432
```
3533

34+
---
35+
3636
## 🧪 Usage
37+
3738
```bash
3839
ApiQube is a powerful test manager for apps and APIs
3940

@@ -55,11 +56,48 @@ Flags:
5556
Use "qube [command] --help" for more information about a command.
5657
```
5758

59+
---
60+
61+
## 📝 Example
62+
63+
Create a YAML manifest describing your test plan, then apply it:
64+
65+
```bash
66+
qube apply -f my-test-plan.yaml
67+
```
68+
69+
Search for existing manifests:
70+
71+
```bash
72+
qube search --filter "service=api"
73+
```
74+
75+
Rollback to a previous manifest version:
76+
77+
```bash
78+
qube rollback --id my-service --version 2
79+
```
80+
81+
---
82+
5883
## 🌍 Roadmap
59-
- [ ] CLI core
60-
- [ ] YAML-driven testing flows
84+
85+
- [x] CLI core
86+
- [x] YAML-driven testing flows
87+
- [ ] Visual test plan editor
6188
- [ ] Plugin marketplace
6289
- [ ] Built-in Prometheus integration
6390
- [ ] Web dashboard (with Wails)
6491
- [ ] GitHub/GitLab CI integration
65-
- [ ] Visual test plan editor
92+
93+
---
94+
95+
## 🤝 Contributing
96+
97+
Contributions are welcome! Please open issues or pull requests on [GitHub](https://github.com/apiqube/cli).
98+
99+
---
100+
101+
## 📄 License
102+
103+
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)