@flexkit/cli 0.1.17 → 0.1.19
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 +20 -4
- package/dist/index.js +468 -178
- package/dist/index.js.map +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
**Flexkit CLI is the command-line interface for managing Flexkit projects from your terminal.**
|
|
17
17
|
|
|
18
|
-
Use it to authenticate, deploy schemas, and
|
|
18
|
+
Use it to authenticate, deploy schemas, work with records, manage automations, skills, knowledge and plugins, talk to the Chat Agent, and script anything else the Flexkit API offers without leaving your terminal.
|
|
19
19
|
|
|
20
20
|
## Usage
|
|
21
21
|
|
|
@@ -29,11 +29,27 @@ Example commands:
|
|
|
29
29
|
|
|
30
30
|
```shell
|
|
31
31
|
flexkit login
|
|
32
|
-
flexkit
|
|
33
|
-
flexkit
|
|
34
|
-
flexkit
|
|
32
|
+
flexkit link # link this folder to a project; later commands use it
|
|
33
|
+
flexkit deploy # deploy the schema from flexkit.config.ts
|
|
34
|
+
flexkit schema diff # compare the local schema with the deployed one
|
|
35
|
+
flexkit dev # run the tools and skills from flexkit.tools.ts as your local runtime
|
|
36
|
+
|
|
37
|
+
flexkit records ls product --limit 10
|
|
38
|
+
flexkit query '{ products(limit: 5) { _id sku name { default } } }'
|
|
39
|
+
|
|
40
|
+
flexkit chat "Which orders shipped late this week?"
|
|
41
|
+
flexkit automations ls
|
|
42
|
+
flexkit runs logs <runId> --follow
|
|
43
|
+
flexkit skills pull ./skills # keep skills in git; push them back with `flexkit skills push`
|
|
44
|
+
flexkit knowledge add ./docs --wait
|
|
45
|
+
|
|
46
|
+
flexkit api /automations # call any API endpoint with your credentials
|
|
35
47
|
```
|
|
36
48
|
|
|
49
|
+
Every command prints help with examples: `flexkit <command> --help`. Commands that read data accept `--json` and print it on stdout, so the output can be piped to `jq`.
|
|
50
|
+
|
|
51
|
+
In CI, set `FLEXKIT_TOKEN` and `FLEXKIT_PROJECT_ID` instead of logging in.
|
|
52
|
+
|
|
37
53
|
## Documentation
|
|
38
54
|
|
|
39
55
|
For details on how to use Flexkit CLI, check out our [documentation](https://flexkit.io/docs/cli).
|