@datachonk/cli 0.2.0 → 0.2.4
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/LICENSE +45 -0
- package/README.md +103 -8
- package/package.json +3 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
DataChonk CLI - Proprietary License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 DataChonk. All rights reserved.
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS
|
|
6
|
+
|
|
7
|
+
1. GRANT OF LICENSE
|
|
8
|
+
You are granted a non-exclusive, non-transferable license to use the
|
|
9
|
+
DataChonk CLI software ("Software") for personal or commercial purposes,
|
|
10
|
+
subject to the terms of this license.
|
|
11
|
+
|
|
12
|
+
2. RESTRICTIONS
|
|
13
|
+
You may NOT:
|
|
14
|
+
- Modify, adapt, or create derivative works of the Software
|
|
15
|
+
- Redistribute, sublicense, sell, or transfer the Software
|
|
16
|
+
- Reverse engineer, decompile, or disassemble the Software
|
|
17
|
+
- Remove or alter any proprietary notices or labels
|
|
18
|
+
- Use the Software to create a competing product or service
|
|
19
|
+
|
|
20
|
+
3. PERMITTED USE
|
|
21
|
+
You MAY:
|
|
22
|
+
- Install and use the Software for its intended purpose
|
|
23
|
+
- Use the Software in connection with DataChonk services
|
|
24
|
+
- Make copies solely for backup purposes
|
|
25
|
+
|
|
26
|
+
4. OWNERSHIP
|
|
27
|
+
The Software and all copies thereof are proprietary to DataChonk and
|
|
28
|
+
title thereto remains exclusively with DataChonk. All rights not
|
|
29
|
+
specifically granted in this license are reserved by DataChonk.
|
|
30
|
+
|
|
31
|
+
5. TERMINATION
|
|
32
|
+
This license is effective until terminated. It will terminate
|
|
33
|
+
automatically if you fail to comply with any term of this license.
|
|
34
|
+
Upon termination, you must destroy all copies of the Software.
|
|
35
|
+
|
|
36
|
+
6. DISCLAIMER OF WARRANTIES
|
|
37
|
+
THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
38
|
+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
39
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
40
|
+
|
|
41
|
+
7. LIMITATION OF LIABILITY
|
|
42
|
+
IN NO EVENT SHALL DATACHONK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
43
|
+
LIABILITY ARISING FROM THE USE OF THE SOFTWARE.
|
|
44
|
+
|
|
45
|
+
For questions about licensing, contact: legal@datachonk.dev
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @datachonk/cli
|
|
2
2
|
|
|
3
|
-
AI-powered dbt expert CLI - analyze, generate, and optimize your dbt projects.
|
|
3
|
+
AI-powered dbt expert CLI - analyze, generate, and optimize your dbt projects with Chonk, your data-sniffing corgi.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -13,22 +13,87 @@ npx @datachonk/cli
|
|
|
13
13
|
## Quick Start
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
+
# Login to DataChonk
|
|
17
|
+
datachonk auth login
|
|
18
|
+
|
|
16
19
|
# Initialize DataChonk in your dbt project
|
|
17
20
|
cd your-dbt-project
|
|
18
21
|
datachonk init
|
|
19
22
|
|
|
23
|
+
# Chat with Chonk AI
|
|
24
|
+
datachonk chat
|
|
25
|
+
|
|
20
26
|
# Analyze your project for issues
|
|
21
27
|
datachonk analyze
|
|
22
28
|
|
|
23
29
|
# Generate a new staging model
|
|
24
30
|
datachonk generate staging --name customers --source raw.stripe.customers
|
|
25
|
-
|
|
26
|
-
# Review code before committing
|
|
27
|
-
datachonk review
|
|
28
31
|
```
|
|
29
32
|
|
|
30
33
|
## Commands
|
|
31
34
|
|
|
35
|
+
### Authentication
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
datachonk auth login # Login via browser or API key
|
|
39
|
+
datachonk auth logout # Logout and clear credentials
|
|
40
|
+
datachonk auth whoami # Show current user info
|
|
41
|
+
datachonk auth token # Display current API token
|
|
42
|
+
datachonk auth token --create # Create a new API token
|
|
43
|
+
datachonk auth token --revoke # Revoke current token
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Project Management
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
datachonk projects list # List all your projects
|
|
50
|
+
datachonk projects create # Create a new project (interactive)
|
|
51
|
+
datachonk projects show <id> # Show project details
|
|
52
|
+
datachonk projects delete <id> # Delete a project
|
|
53
|
+
datachonk projects export <id> # Export project as ZIP
|
|
54
|
+
datachonk projects export <id> --extract ./output # Extract to folder
|
|
55
|
+
datachonk projects clone <id> # Clone to local dbt project
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Sync & Pull
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
datachonk sync # Sync local dbt project to DataChonk
|
|
62
|
+
datachonk sync --project <id> # Sync to specific project
|
|
63
|
+
datachonk sync --watch # Watch for changes and auto-sync
|
|
64
|
+
datachonk pull # Pull changes from DataChonk
|
|
65
|
+
datachonk pull --project <id> # Pull from specific project
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Status & Dashboard
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
datachonk status # Show dashboard with usage stats
|
|
72
|
+
datachonk open # Open web dashboard in browser
|
|
73
|
+
datachonk open projects # Open projects page
|
|
74
|
+
datachonk open settings # Open settings page
|
|
75
|
+
datachonk version # Show version and check for updates
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### AI Chat (Chonk)
|
|
79
|
+
|
|
80
|
+
Interactive AI assistant for dbt help and code generation.
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
datachonk chat # Start interactive chat
|
|
84
|
+
datachonk chat -c ./models # Include directory as context
|
|
85
|
+
datachonk chat -p <project-id> # Use project context
|
|
86
|
+
datachonk chat --no-stream # Disable streaming responses
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Chat Slash Commands:**
|
|
90
|
+
- `/help` - Show available commands
|
|
91
|
+
- `/clear` - Clear conversation history
|
|
92
|
+
- `/context <path>` - Load a file or directory as context
|
|
93
|
+
- `/save <file>` - Save the last code block to a file
|
|
94
|
+
- `/export` - Export conversation to markdown
|
|
95
|
+
- `/exit` - Exit chat
|
|
96
|
+
|
|
32
97
|
### `datachonk init`
|
|
33
98
|
|
|
34
99
|
Initialize DataChonk in your dbt project. Creates a `.datachonk.yml` configuration file.
|
|
@@ -83,6 +148,16 @@ datachonk review --strict # Enable strict mode
|
|
|
83
148
|
datachonk review --json # Output as JSON
|
|
84
149
|
```
|
|
85
150
|
|
|
151
|
+
### `datachonk scan`
|
|
152
|
+
|
|
153
|
+
Discover and analyze your data warehouse schema.
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
datachonk scan # Interactive warehouse scan
|
|
157
|
+
datachonk scan --connection <name> # Use saved connection
|
|
158
|
+
datachonk scan --output schema.json # Export schema to file
|
|
159
|
+
```
|
|
160
|
+
|
|
86
161
|
### `datachonk lineage`
|
|
87
162
|
|
|
88
163
|
Analyze and visualize model lineage.
|
|
@@ -107,6 +182,25 @@ datachonk docs --missing-only # Only document undocumented models
|
|
|
107
182
|
datachonk docs --enhance # Use AI to improve descriptions
|
|
108
183
|
```
|
|
109
184
|
|
|
185
|
+
### `datachonk test`
|
|
186
|
+
|
|
187
|
+
Run and manage dbt tests.
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
datachonk test # Run all tests
|
|
191
|
+
datachonk test --model stg_users # Test specific model
|
|
192
|
+
datachonk test --generate # Generate missing tests
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### `datachonk migrate`
|
|
196
|
+
|
|
197
|
+
Convert raw SQL to dbt models.
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
datachonk migrate query.sql # Convert SQL file to dbt
|
|
201
|
+
datachonk migrate --interactive # Interactive migration wizard
|
|
202
|
+
```
|
|
203
|
+
|
|
110
204
|
### `datachonk config`
|
|
111
205
|
|
|
112
206
|
Manage DataChonk configuration.
|
|
@@ -115,6 +209,7 @@ Manage DataChonk configuration.
|
|
|
115
209
|
datachonk config list # Show all configuration
|
|
116
210
|
datachonk config get warehouse # Get specific value
|
|
117
211
|
datachonk config set warehouse bigquery # Set value
|
|
212
|
+
datachonk config set apiKey <key> # Set API key
|
|
118
213
|
datachonk config reset # Reset to defaults
|
|
119
214
|
```
|
|
120
215
|
|
|
@@ -160,11 +255,11 @@ jobs:
|
|
|
160
255
|
lint:
|
|
161
256
|
runs-on: ubuntu-latest
|
|
162
257
|
steps:
|
|
163
|
-
- uses: actions/checkout@
|
|
164
|
-
- uses: actions/setup-node@
|
|
258
|
+
- uses: actions/checkout@v4
|
|
259
|
+
- uses: actions/setup-node@v4
|
|
165
260
|
with:
|
|
166
|
-
node-version: '
|
|
167
|
-
- run: npm install -g datachonk
|
|
261
|
+
node-version: '20'
|
|
262
|
+
- run: npm install -g @datachonk/cli
|
|
168
263
|
- run: datachonk analyze --json > analysis.json
|
|
169
264
|
- run: datachonk review --strict
|
|
170
265
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@datachonk/cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "AI-powered dbt expert CLI - analyze, generate, and optimize your dbt projects",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"type": "module",
|
|
@@ -39,10 +39,10 @@
|
|
|
39
39
|
"databricks"
|
|
40
40
|
],
|
|
41
41
|
"author": "DataChonk",
|
|
42
|
-
"license": "
|
|
42
|
+
"license": "SEE LICENSE IN LICENSE",
|
|
43
43
|
"repository": {
|
|
44
44
|
"type": "git",
|
|
45
|
-
"url": "https://github.com/
|
|
45
|
+
"url": "https://github.com/llschmidt/datachonk-cli"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"adm-zip": "^0.5.10",
|