@stagware/nocodb-cli 0.1.0
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 +90 -0
- package/dist/index.js +6539 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# @stagware/nocodb-cli
|
|
2
|
+
|
|
3
|
+
Command-line interface for NocoDB — manage bases, tables, rows, views, and more from the terminal.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g @stagware/nocodb-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
# Configure
|
|
15
|
+
nocodb workspace add myserver https://app.nocodb.com <api-token> --base <baseId>
|
|
16
|
+
nocodb workspace use myserver
|
|
17
|
+
|
|
18
|
+
# Or use environment variables
|
|
19
|
+
export NOCO_BASE_URL=https://app.nocodb.com
|
|
20
|
+
export NOCO_TOKEN=your-api-token
|
|
21
|
+
export NOCO_BASE_ID=p_abc123
|
|
22
|
+
|
|
23
|
+
# Verify auth
|
|
24
|
+
nocodb me
|
|
25
|
+
|
|
26
|
+
# List bases and tables
|
|
27
|
+
nocodb bases list
|
|
28
|
+
nocodb tables list <baseId>
|
|
29
|
+
|
|
30
|
+
# CRUD on rows
|
|
31
|
+
nocodb rows list <tableId>
|
|
32
|
+
nocodb rows create <tableId> --data '{"Title":"Hello"}'
|
|
33
|
+
nocodb rows update <tableId> --data '{"Id":1,"Title":"Updated"}'
|
|
34
|
+
nocodb rows delete <tableId> --data '{"Id":1}'
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Features
|
|
38
|
+
|
|
39
|
+
- **90+ commands** covering all NocoDB v2 API operations
|
|
40
|
+
- **Multi-workspace** support with per-workspace aliases
|
|
41
|
+
- **Data import/export** — CSV and JSON with schema validation
|
|
42
|
+
- **Output formats** — JSON, CSV, ASCII table, with `--select` field filtering
|
|
43
|
+
- **Dynamic API** — auto-generated commands from Swagger specs
|
|
44
|
+
- **Configurable** — retry, timeout, verbose mode
|
|
45
|
+
- **Environment variables** — `NOCO_TOKEN`, `NOCO_BASE_URL`, `NOCO_BASE_ID` for CI/CD
|
|
46
|
+
|
|
47
|
+
## Commands
|
|
48
|
+
|
|
49
|
+
| Category | Commands |
|
|
50
|
+
|----------|----------|
|
|
51
|
+
| **Bases** | `bases list/get/info/create/update/delete` |
|
|
52
|
+
| **Tables** | `tables list/get/create/update/delete` |
|
|
53
|
+
| **Views** | `views list/get/create/update/delete`, `views config get/update`, `views columns list` |
|
|
54
|
+
| **Columns** | `columns list/get/create/update/delete/set-primary` |
|
|
55
|
+
| **Rows** | `rows list/read/create/update/delete/upsert/bulk-create/bulk-update/bulk-upsert/bulk-delete` |
|
|
56
|
+
| **Filters** | `filters list/get/create/update/delete/children` |
|
|
57
|
+
| **Sorts** | `sorts list/get/create/update/delete` |
|
|
58
|
+
| **Links** | `links list/create/delete` |
|
|
59
|
+
| **Hooks** | `hooks list/get/create/update/delete/test`, `hooks filters list/create` |
|
|
60
|
+
| **Sources** | `sources list/get/create/update/delete` |
|
|
61
|
+
| **Tokens** | `tokens list/create/delete` |
|
|
62
|
+
| **Users** | `users list/invite/update/remove` |
|
|
63
|
+
| **Comments** | `comments list/create/update/delete` |
|
|
64
|
+
| **Shared Views** | `shared-views list/create/update/delete` |
|
|
65
|
+
| **Shared Base** | `shared-base get/create/update/delete` |
|
|
66
|
+
| **Data I/O** | `data export/import` (CSV/JSON) |
|
|
67
|
+
| **Schema** | `schema introspect` |
|
|
68
|
+
| **Storage** | `storage upload` |
|
|
69
|
+
| **Settings** | `settings show/path/set/reset` |
|
|
70
|
+
| **Workspaces** | `workspace add/use/list/show/delete` |
|
|
71
|
+
| **Cloud** | `workspace cloud list/get/create/update/delete/users/invite/bases` |
|
|
72
|
+
| **Aliases** | `alias set/list/delete/clear` |
|
|
73
|
+
| **Other** | `me`, `info`, `duplicate`, `visibility-rules`, `request`, `meta`, `api` |
|
|
74
|
+
|
|
75
|
+
## Output Formats
|
|
76
|
+
|
|
77
|
+
```sh
|
|
78
|
+
nocodb bases list --pretty # indented JSON
|
|
79
|
+
nocodb bases list --format csv # CSV
|
|
80
|
+
nocodb bases list --format table # ASCII table
|
|
81
|
+
nocodb bases list --select id,title # field filtering
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Documentation
|
|
85
|
+
|
|
86
|
+
See the full [README](https://github.com/stagware/nocodb-cli#readme) for detailed usage, examples, and configuration options.
|
|
87
|
+
|
|
88
|
+
## License
|
|
89
|
+
|
|
90
|
+
MIT
|