@hyperline/cli 0.1.0-build.1.ec7ea00 → 0.1.0-build.1.ecee3bf
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +108 -0
- package/dist/bin/hyperline-main.js +47144 -5139
- package/dist/external-deps.json +20 -0
- package/package.json +18 -3
package/README.md
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# @hyperline/cli
|
|
2
|
+
|
|
3
|
+
The official command-line interface for [Hyperline](https://www.hyperline.co) — the billing platform built for modern SaaS.
|
|
4
|
+
|
|
5
|
+
Manage your customers, subscriptions, invoices, products, and more directly from your terminal.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @hyperline/cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick start
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Authenticate with your Hyperline account
|
|
17
|
+
hyperline login
|
|
18
|
+
|
|
19
|
+
# List your customers
|
|
20
|
+
hyperline customers list
|
|
21
|
+
|
|
22
|
+
# Create a new customer
|
|
23
|
+
hyperline customers create --name "Acme Inc" --currency USD
|
|
24
|
+
|
|
25
|
+
# Get a specific invoice
|
|
26
|
+
hyperline invoices get --id inv_xxxxx
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Authentication
|
|
30
|
+
|
|
31
|
+
### Browser login
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
hyperline login
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Opens your browser to securely authenticate with your Hyperline account. Credentials are stored locally in `~/.hyperline/`.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
hyperline logout
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### API key
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# Via environment variable
|
|
47
|
+
export HYPERLINE_API_KEY=sk_test_...
|
|
48
|
+
|
|
49
|
+
# Or inline
|
|
50
|
+
hyperline customers list --api-key sk_test_...
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Resources
|
|
54
|
+
|
|
55
|
+
Manage every part of your billing stack from the CLI:
|
|
56
|
+
|
|
57
|
+
- **Customers** — create, update, list, and manage your customer base
|
|
58
|
+
- **Subscriptions** — handle subscription lifecycle, cancellations, and templates
|
|
59
|
+
- **Invoices** — create, list, and manage invoices and transactions
|
|
60
|
+
- **Products** — define and update your product catalog
|
|
61
|
+
- **Quotes** — generate and manage quotes
|
|
62
|
+
- **Wallets** — prepaid wallet management and top-ups
|
|
63
|
+
- **Coupons & Promotions** — create discount coupons and promotion codes
|
|
64
|
+
- **Webhooks** — configure webhook endpoints
|
|
65
|
+
- **Payments** — track and manage payments
|
|
66
|
+
- **Analytics** — access billing metrics
|
|
67
|
+
- **Exports** — export your billing data
|
|
68
|
+
- **Custom Properties** — extend resources with custom fields
|
|
69
|
+
- **Taxes** — view tax rates and configurations
|
|
70
|
+
- **Invoicing Entities** — manage your billing entities
|
|
71
|
+
|
|
72
|
+
### Examples
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# Filter invoices by status
|
|
76
|
+
hyperline invoices list --status draft --take 10
|
|
77
|
+
|
|
78
|
+
# Output as JSON for scripting
|
|
79
|
+
hyperline customers list --output json
|
|
80
|
+
|
|
81
|
+
# Pipe to other tools
|
|
82
|
+
hyperline customers list --output json | jq '.[].name'
|
|
83
|
+
|
|
84
|
+
# Use a custom API endpoint
|
|
85
|
+
hyperline customers list --base-url https://api.sandbox.hyperline.co
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Global options
|
|
89
|
+
|
|
90
|
+
| Option | Description |
|
|
91
|
+
|---|---|
|
|
92
|
+
| `--api-key <key>` | API key (overrides `HYPERLINE_API_KEY`) |
|
|
93
|
+
| `--base-url <url>` | API base URL (overrides `HYPERLINE_API_URL`) |
|
|
94
|
+
| `--output <format>` | `json` or `text` (default: `text`) |
|
|
95
|
+
| `--help` | Show help |
|
|
96
|
+
| `--version` | Show version |
|
|
97
|
+
|
|
98
|
+
## Environment variables
|
|
99
|
+
|
|
100
|
+
| Variable | Description |
|
|
101
|
+
|---|---|
|
|
102
|
+
| `HYPERLINE_API_KEY` | API key for authentication |
|
|
103
|
+
| `HYPERLINE_API_URL` | Custom API base URL |
|
|
104
|
+
|
|
105
|
+
## Learn more
|
|
106
|
+
|
|
107
|
+
- [Hyperline Documentation](https://docs.hyperline.co)
|
|
108
|
+
- [API Reference](https://docs.hyperline.co/api-reference)
|