From 82965d1e89fdf41f0dd0947e37906cfef53733ba Mon Sep 17 00:00:00 2001 From: Pavel Jbanov Date: Mon, 13 May 2024 13:56:00 -0400 Subject: [PATCH 1/7] Updated the CLI readme --- genkit-tools/cli/README.md | 54 +++++++++++++++++++++++++++++--------- 1 file changed, 42 insertions(+), 12 deletions(-) diff --git a/genkit-tools/cli/README.md b/genkit-tools/cli/README.md index 6abfb6f89b..e294f0495b 100644 --- a/genkit-tools/cli/README.md +++ b/genkit-tools/cli/README.md @@ -1,17 +1,47 @@ -Genkit CLI. +# Firebase Genkit CLI. -Right now this is just scaffolding. To build, +To install the CLI +```bash +npm i -g genkit ``` -pnpm i -pnpm build -``` -After executing `npm link`, the `genkit` binary will be in your local path. -Call `genkit example` to see the example. +Available commands: + + * `init [options]` + + initialize a project directory with Genkit + + * `start [options]` + + run the app in dev mode and start a Developer UI + + * `flow:run [options] [data]` + + run a flow using provided data as input + + * `flow:batchRun [options] ` + + batch run a flow using provided set of data from a file as input + + * `flow:resume ` + + resume an interrupted flow (experimental) + + * `eval:extractData [options] ` + + extract evaludation data for a given flow from the trace store + + * `eval:run [options] ` + + evaluate provided dataset against configured evaluators + + * `eval:flow [options] [data]` + + evaluate a flow against configured evaluators using provided data as input + + * `config` + + set development environment configuration -We're following a slightly different architecture from Firebase Tools. For -commands, Firebase Tools relies on node `require()` calls to dynamically load -code. This is discouraged (in fact, disabled per our TSLint) so instead -all files (and thus all commands) need to be directly referenced from something -in the tree of imports. See `src/cli.ts`. + * `help` \ No newline at end of file From 8e3f0b87734ab6b527a4348dc6866919e7c10092 Mon Sep 17 00:00:00 2001 From: Pavel Jbanov Date: Mon, 13 May 2024 13:57:11 -0400 Subject: [PATCH 2/7] format --- genkit-tools/cli/README.md | 46 +++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/genkit-tools/cli/README.md b/genkit-tools/cli/README.md index e294f0495b..bb73580851 100644 --- a/genkit-tools/cli/README.md +++ b/genkit-tools/cli/README.md @@ -8,40 +8,40 @@ npm i -g genkit Available commands: - * `init [options]` +- `init [options]` - initialize a project directory with Genkit + initialize a project directory with Genkit - * `start [options]` - - run the app in dev mode and start a Developer UI +- `start [options]` - * `flow:run [options] [data]` - - run a flow using provided data as input + run the app in dev mode and start a Developer UI - * `flow:batchRun [options] ` - - batch run a flow using provided set of data from a file as input +- `flow:run [options] [data]` - * `flow:resume ` - - resume an interrupted flow (experimental) + run a flow using provided data as input - * `eval:extractData [options] ` +- `flow:batchRun [options] ` - extract evaludation data for a given flow from the trace store + batch run a flow using provided set of data from a file as input - * `eval:run [options] ` +- `flow:resume ` - evaluate provided dataset against configured evaluators + resume an interrupted flow (experimental) - * `eval:flow [options] [data]` +- `eval:extractData [options] ` - evaluate a flow against configured evaluators using provided data as input + extract evaludation data for a given flow from the trace store - * `config` +- `eval:run [options] ` - set development environment configuration + evaluate provided dataset against configured evaluators - * `help` \ No newline at end of file +- `eval:flow [options] [data]` + + evaluate a flow against configured evaluators using provided data as input + +- `config` + + set development environment configuration + +- `help` From 80d8bcd883d24508a6ea54905dbb086517839a99 Mon Sep 17 00:00:00 2001 From: Pavel Jbanov Date: Mon, 13 May 2024 14:03:09 -0400 Subject: [PATCH 3/7] Update genkit-tools/cli/README.md Co-authored-by: Kevin Cheung --- genkit-tools/cli/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/genkit-tools/cli/README.md b/genkit-tools/cli/README.md index bb73580851..66fcd593dd 100644 --- a/genkit-tools/cli/README.md +++ b/genkit-tools/cli/README.md @@ -1,6 +1,6 @@ # Firebase Genkit CLI. -To install the CLI +To install the CLI: ```bash npm i -g genkit From 2eb130fc1f76505706ad9fe2cee5b37b53032859 Mon Sep 17 00:00:00 2001 From: Pavel Jbanov Date: Mon, 13 May 2024 14:03:20 -0400 Subject: [PATCH 4/7] Update genkit-tools/cli/README.md Co-authored-by: Kevin Cheung --- genkit-tools/cli/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/genkit-tools/cli/README.md b/genkit-tools/cli/README.md index 66fcd593dd..595d677d2f 100644 --- a/genkit-tools/cli/README.md +++ b/genkit-tools/cli/README.md @@ -1,4 +1,4 @@ -# Firebase Genkit CLI. +# Firebase Genkit CLI To install the CLI: From 33751dcd5e0e04bd9d82b7d865b79d89c3e12a9e Mon Sep 17 00:00:00 2001 From: Pavel Jbanov Date: Mon, 13 May 2024 14:26:42 -0400 Subject: [PATCH 5/7] Update genkit-tools/cli/README.md Co-authored-by: Chris Ray Gill --- genkit-tools/cli/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/genkit-tools/cli/README.md b/genkit-tools/cli/README.md index 595d677d2f..1cf2e3f25b 100644 --- a/genkit-tools/cli/README.md +++ b/genkit-tools/cli/README.md @@ -1,5 +1,7 @@ # Firebase Genkit CLI +The package contains the CLI for Firebase Genkit, an open source framework with rich local tooling to help app developers build, test, deploy, and monitor AI-powered features for their apps with confidence. Genkit is built by Firebase, Google's app development platform that is trusted by millions of businesses around the world. +Review the [documentation](https://firebase.google.com/docs/genkit) for details and samples. To install the CLI: ```bash From 193a0684c5ab1470f9782bbd8b87e641e37cc0ba Mon Sep 17 00:00:00 2001 From: Pavel Jbanov Date: Mon, 13 May 2024 14:27:09 -0400 Subject: [PATCH 6/7] Update genkit-tools/cli/README.md --- genkit-tools/cli/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/genkit-tools/cli/README.md b/genkit-tools/cli/README.md index 1cf2e3f25b..b44b8c60e0 100644 --- a/genkit-tools/cli/README.md +++ b/genkit-tools/cli/README.md @@ -1,4 +1,5 @@ # Firebase Genkit CLI + The package contains the CLI for Firebase Genkit, an open source framework with rich local tooling to help app developers build, test, deploy, and monitor AI-powered features for their apps with confidence. Genkit is built by Firebase, Google's app development platform that is trusted by millions of businesses around the world. Review the [documentation](https://firebase.google.com/docs/genkit) for details and samples. From 79ffcc434570b38fdd5e9d1fa6221f82b208d749 Mon Sep 17 00:00:00 2001 From: Pavel Jbanov Date: Mon, 13 May 2024 14:27:33 -0400 Subject: [PATCH 7/7] Update genkit-tools/cli/README.md --- genkit-tools/cli/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/genkit-tools/cli/README.md b/genkit-tools/cli/README.md index b44b8c60e0..a22da2f884 100644 --- a/genkit-tools/cli/README.md +++ b/genkit-tools/cli/README.md @@ -3,6 +3,7 @@ The package contains the CLI for Firebase Genkit, an open source framework with rich local tooling to help app developers build, test, deploy, and monitor AI-powered features for their apps with confidence. Genkit is built by Firebase, Google's app development platform that is trusted by millions of businesses around the world. Review the [documentation](https://firebase.google.com/docs/genkit) for details and samples. + To install the CLI: ```bash