sheetlink 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +84 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,84 @@
1
+ # sheetlink
2
+
3
+ CLI for SheetLink — sync your bank transactions to any destination.
4
+
5
+ ```
6
+ npm install -g sheetlink
7
+ ```
8
+
9
+ Requires a [SheetLink](https://sheetlink.app) account on the **PRO** or **MAX** tier.
10
+
11
+ ---
12
+
13
+ ## Commands
14
+
15
+ ### `sheetlink auth`
16
+ Authenticate with SheetLink.
17
+
18
+ ```bash
19
+ sheetlink auth # OAuth login (PRO)
20
+ sheetlink auth --api-key sl_... # API key (MAX — for automation)
21
+ ```
22
+
23
+ ### `sheetlink sync`
24
+ Sync transactions from all connected banks.
25
+
26
+ ```bash
27
+ sheetlink sync # JSON to stdout (default)
28
+ sheetlink sync | jq '.items[].transactions | length' # Pipe to jq
29
+ sheetlink sync --output csv # CSV snapshot
30
+ sheetlink sync --output csv --file ~/finances.csv # CSV to custom path
31
+ sheetlink sync --output postgres://localhost/mydb # Upsert to Postgres (MAX)
32
+ sheetlink sync --output sqlite:///~/finance.db # Upsert to SQLite (MAX)
33
+ sheetlink sync --item <item_id> # One bank only
34
+ ```
35
+
36
+ ### `sheetlink items`
37
+ List connected bank accounts.
38
+
39
+ ```bash
40
+ sheetlink items
41
+ ```
42
+
43
+ ### `sheetlink config`
44
+ View or update CLI configuration.
45
+
46
+ ```bash
47
+ sheetlink config # Show current config
48
+ sheetlink config --set default_output=csv # Set default output
49
+ ```
50
+
51
+ **Settable keys:**
52
+ - `default_output` — `json`, `csv`, `postgres://...`, `sqlite://...`
53
+ - `api_url` — Backend URL (default: `https://api.sheetlink.app`)
54
+
55
+ **Environment variable overrides:**
56
+ - `SHEETLINK_API_KEY` — API key (MAX tier)
57
+ - `SHEETLINK_OUTPUT` — Default output destination
58
+ - `SHEETLINK_API_URL` — Backend URL
59
+
60
+ ---
61
+
62
+ ## Tiers
63
+
64
+ | Feature | PRO | MAX |
65
+ |---|---|---|
66
+ | JSON / CSV output | ✅ | ✅ |
67
+ | Postgres output | — | ✅ |
68
+ | SQLite output | — | ✅ |
69
+ | API key auth (unattended/cron) | — | ✅ |
70
+
71
+ [View pricing →](https://sheetlink.app/pricing)
72
+
73
+ ---
74
+
75
+ ## Requirements
76
+
77
+ - Node.js 18+
78
+ - A SheetLink account with at least one connected bank ([sheetlink.app/dashboard](https://sheetlink.app/dashboard))
79
+
80
+ ---
81
+
82
+ ## License
83
+
84
+ MIT © [SheetLink](https://sheetlink.app)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sheetlink",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "CLI for SheetLink — sync your bank transactions to any destination",
5
5
  "type": "module",
6
6
  "bin": {
@@ -36,6 +36,6 @@
36
36
  "license": "MIT",
37
37
  "repository": {
38
38
  "type": "git",
39
- "url": "https://github.com/sheetlink/sheetlink-client"
39
+ "url": "https://github.com/sheetlink/cli"
40
40
  }
41
41
  }