-
Notifications
You must be signed in to change notification settings - Fork 566
Updated the CLI readme #151
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
82965d1
Updated the CLI readme
pavelgj 8e3f0b8
format
pavelgj 80d8bcd
Update genkit-tools/cli/README.md
pavelgj 2eb130f
Update genkit-tools/cli/README.md
pavelgj 33751dc
Update genkit-tools/cli/README.md
pavelgj 193a068
Update genkit-tools/cli/README.md
pavelgj 79ffcc4
Update genkit-tools/cli/README.md
pavelgj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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, | ||
| 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` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.