@keragon/connector-cli 0.0.4 → 0.0.5

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 (3) hide show
  1. package/README.md +14 -82
  2. package/main.js +1 -1
  3. package/package.json +2 -1
package/README.md CHANGED
@@ -1,91 +1,23 @@
1
- # Keragon monorepo
1
+ # Keragon Connector CLI
2
2
 
3
- Welcome to Keragon's monorepo! Please read below for more info and instructions on how to use.
3
+ The official command-line interface (CLI) for building, testing, and managing connectors on the Keragon platform.
4
4
 
5
- - [Local development setup guide](https://www.notion.so/keragon/Keragon-Local-Development-Guide-160d9e88eb8e46bdad51d8b33a865f3d)
6
- - [App configuration setup](https://www.notion.so/App-Config-b7f62c2df4324b329cf9e41412b2f3de)
5
+ ## Installation
7
6
 
8
- ## Nx
9
-
10
- Keragon uses [Nx](https://nx.dev/) to build, maintain and grow our codebase.
11
-
12
- **Why Nx?**
13
-
14
- - Code generation / scaffolding — generators generate applications, components, standard pieces of code (like cookie-cutters) — they also help you migrate across versions. This helps to maintain consistency as we grow.
15
- - Dependency graph and code change analysis — only build/test/lint projects that are affected by a code change — Nx understands your workspace, and makes optimizations — it also visualizes the dependencies with the dependency graph
16
- - Speed — computation caching will ensure that when you rerun the same command, the results will be fetched from the cache — together with the affected command and distributed task execution and Nx Cloud you never build/test/lint the same code twice
17
- - Nx CLI — Integrated environment with consistent syntax for executing commands.
18
- - Plugins — for modern web technologies and tools include their own executors and generators which will help you develop projects using the tools you like
19
- - IDE integration — Nx Editor Plugins give you access to all that the Nx CLI can do, but from a GUI.
20
-
21
- [Source](https://blog.nrwl.io/build-your-design-system-with-storybook-nx-e3bde4087ad8)
22
-
23
- ## Packages
24
-
25
- This monorepo contains the following packages:
26
-
27
- | Subfolder | Description |
28
- |------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
29
- | [`apps/api/`](apps/api/) | This package hosts Keragon's API
30
- | [`apps/billing`](apps/billing/) | Billing service (temporal worker billing)
31
- | [`apps/dashboard/`](apps/dashboard) | A web app for building workflows visually |
32
- | [`apps/dsl-runtime/`](apps/dsl-runtime) | This package is used to run workflows and manage their runtime |
33
- | [`packages/catalog-client`](packages/catalog-client) | Connector catalog client as source of truth for available connectors in Keragon
34
- | [`packages/dsl-sdk/`](packages/dsl-sdk) | The DSL SDK is used to build and manipulate Keragon's workflow DSL |
35
- | [`packages/authentications/`](packages/authentications) | This package manages 3rd party app authorizations |
36
- | [`packages/connector-sdk/`](packages/connector-sdk/) | This is the SDK for building new connectors.
37
- | [`packages/connectors/`](packages/connectors/) | This package hosts all the Keragon built-in connectors.
38
- | [`packages/copilot`](packages/copilot/) | A Langgraph implementation of our Copilot
39
- | [`packages/fixtures/`](packages/fixtures/) | This package hosts fixtures reused in tests across Keragon. This is the central place with the latest DSL configuration too.
40
- | [`packages/secrets-manager/`](packages/secrets-manager/) | A wrapper around AWS Secrets Manager and KMS clients to be reused across the monorepo.
41
- | [`packages/jq-parser/`](packages/jq-parser/) | Parses JQ expressions into easily parsable structures.
42
- | [`packages/dashboard-auth/`](packages/dashboard-auth/) | React components related to the auth flow in the dashboard.
43
- | [`packages/shared/ui/`](packages/shared/ui/) | Keragon's reusable React components.
44
- | [`packages/shared/util-credentials/`](packages/shared/util-credentials/) | Credentials related utility methods that are reused across the monorepo.
45
- | [`packages/shared/types/`](packages/shared/types/) | Typescript types/interfaces/classes that are reused across the monorepo.
46
- | [`packages/shared/util-dsl/`](packages/shared/util-dsl/) | Utilities to work with the specific way we use the Serverless DSL in Keragon.
47
- | [`packages/shared/util-jsonschema`](packages/shared/util-jsonschema/) | Utilities to work with json schema that are not available out there eg. `evalSchema`
48
-
49
- ## Main commands
50
-
51
- ### Installing dependencies in workspaces
52
-
53
- `npm install <dep-name> -w @keragon/<package-name>`
54
-
55
- ### Building packages
56
-
57
- - `nx run-many --target=build` (build all)
58
- - `nx run <prohect-name:>build` (build only the specified package)
59
-
60
- ### Running tests
61
-
62
- - `nx run-many --target=test` (build all)
63
-
64
- ### Running eslint
65
-
66
- - `nx run-many --target=lint`
67
-
68
- ### Bootstraping packages
69
-
70
- `npm install`
71
-
72
- ## How to create a new package
73
-
74
- Use an Nx app or library generator. See [docs](https://nx.dev/packages/workspace/generators/new)
75
-
76
- You can install Nx Console in your editor (if suppported) to run these commands from the UI.
77
-
78
- # Service Starter Script
79
-
80
- This script is designed to simplify the process of starting various services in a development environment, including an `ngrok` tunnel and services like `api`, `processor`, `dsl-runtime`, `dashboard`, and `lambda`.
7
+ ```bash
8
+ npm install -g @keragon/connector-cli
9
+ ```
81
10
 
82
11
  ## Usage
83
12
 
84
- To use the script, you may specify one or more services you wish to start. If no services are specified, all available services will be started by default.
85
-
86
- `./start-services.sh [options] [services...]`
13
+ Run the following command to display a list of all available commands:
87
14
 
88
- ### Options
15
+ ```bash
16
+ kc --help
17
+ ```
89
18
 
90
- - `-h`, `--help`: Display the help message and exit.
19
+ Each command supports its own help flag for detailed usage information. For example:
91
20
 
21
+ ```bash
22
+ kc login --help
23
+ ```