@lightdash/cli 2.472.0 → 2.473.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.
- package/README.md +21 -0
- package/dist/.tsbuildinfo.build +1 -1
- package/dist/handlers/agentAccess.d.ts +8 -0
- package/dist/handlers/agentAccess.d.ts.map +1 -0
- package/dist/handlers/agentAccess.js +23 -0
- package/dist/handlers/agentAccess.mock.d.ts +6 -0
- package/dist/handlers/agentAccess.mock.d.ts.map +1 -0
- package/dist/handlers/agentAccess.mock.js +30 -0
- package/dist/handlers/agentConnect.d.ts +8 -0
- package/dist/handlers/agentConnect.d.ts.map +1 -0
- package/dist/handlers/agentConnect.js +164 -0
- package/dist/handlers/agentStatus.d.ts +3 -0
- package/dist/handlers/agentStatus.d.ts.map +1 -0
- package/dist/handlers/agentStatus.js +28 -0
- package/dist/index.js +37 -7
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -15,6 +15,8 @@ Options:
|
|
|
15
15
|
-h, --help display help for command
|
|
16
16
|
|
|
17
17
|
Commands:
|
|
18
|
+
agent connect connect your agent to the warehouse through browser sign-in
|
|
19
|
+
agent status show your agent connection status
|
|
18
20
|
version output the version number
|
|
19
21
|
[dbt_command] runs dbt
|
|
20
22
|
help [command] display help for command
|
|
@@ -22,6 +24,25 @@ Commands:
|
|
|
22
24
|
|
|
23
25
|
eg: `ligthdash test` Runs `dbt test`
|
|
24
26
|
|
|
27
|
+
## Agent connection
|
|
28
|
+
|
|
29
|
+
Use your saved CLI login to connect your agent to the warehouse:
|
|
30
|
+
|
|
31
|
+
```shell
|
|
32
|
+
lightdash agent connect --project my-project
|
|
33
|
+
lightdash agent status --project my-project
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Both commands accept a project UUID or slug. If you omit `--project`, they use
|
|
37
|
+
your saved project. Select one with `lightdash config set-project`.
|
|
38
|
+
|
|
39
|
+
`agent connect` opens a browser and prints the sign-in link for manual use.
|
|
40
|
+
Use `--oauth-port <port>` to choose the local callback port, or set
|
|
41
|
+
`LIGHTDASH_OAUTH_PORT`. Otherwise, the CLI selects an available port.
|
|
42
|
+
`--timeout <seconds>` defaults to 180. After that wait, the CLI checks the
|
|
43
|
+
connection every 3 seconds for up to another 120 seconds. Both commands accept
|
|
44
|
+
`--verbose` and exit with code 1 if the connection is refused or incomplete.
|
|
45
|
+
|
|
25
46
|
## Project validation
|
|
26
47
|
|
|
27
48
|
`lightdash validate` checks existing project content against locally compiled
|