Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the CLI readme #151

Merged
merged 7 commits into from
May 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 46 additions & 12 deletions genkit-tools/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,51 @@
Genkit CLI.
# Firebase Genkit CLI

Right now this is just scaffolding. To build,
pavelgj marked this conversation as resolved.
Show resolved Hide resolved
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.

pavelgj marked this conversation as resolved.
Show resolved Hide resolved
Review the [documentation](https://firebase.google.com/docs/genkit) for details and samples.

pavelgj marked this conversation as resolved.
Show resolved Hide resolved
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] <flowName> [data]`

run a flow using provided data as input

- `flow:batchRun [options] <flowName> <inputFileName>`

batch run a flow using provided set of data from a file as input

- `flow:resume <flowName> <flowId> <data>`

resume an interrupted flow (experimental)

- `eval:extractData [options] <flowName>`

extract evaludation data for a given flow from the trace store

- `eval:run [options] <dataset>`

evaluate provided dataset against configured evaluators

- `eval:flow [options] <flowName> [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`
Loading