mirror of
https://github.com/hwchase17/langchain
synced 2024-11-08 07:10:35 +00:00
bd668fcea1
Will be automatically bumped with `poetry version patch`. @efriis @hwchase17 --------- Co-authored-by: Erick Friis <erick@langchain.dev>
190 lines
3.4 KiB
Markdown
190 lines
3.4 KiB
Markdown
# `langchain`
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain [OPTIONS] COMMAND [ARGS]...
|
|
```
|
|
|
|
**Options**:
|
|
|
|
* `--help`: Show this message and exit.
|
|
* `-v, --version`: Print current CLI version.
|
|
|
|
**Commands**:
|
|
|
|
* `app`: Manage LangChain apps
|
|
* `serve`: Start the LangServe app, whether it's a...
|
|
* `template`: Develop installable templates.
|
|
|
|
## `langchain app`
|
|
|
|
Manage LangChain apps
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain app [OPTIONS] COMMAND [ARGS]...
|
|
```
|
|
|
|
**Options**:
|
|
|
|
* `--help`: Show this message and exit.
|
|
|
|
**Commands**:
|
|
|
|
* `add`: Adds the specified template to the current...
|
|
* `new`: Create a new LangServe application.
|
|
* `remove`: Removes the specified package from the...
|
|
* `serve`: Starts the LangServe app.
|
|
|
|
### `langchain app add`
|
|
|
|
Adds the specified template to the current LangServe app.
|
|
|
|
e.g.:
|
|
langchain app add extraction-openai-functions
|
|
langchain app add git+ssh://git@github.com/efriis/simple-pirate.git
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain app add [OPTIONS] [DEPENDENCIES]...
|
|
```
|
|
|
|
**Arguments**:
|
|
|
|
* `[DEPENDENCIES]...`: The dependency to add
|
|
|
|
**Options**:
|
|
|
|
* `--api-path TEXT`: API paths to add
|
|
* `--project-dir PATH`: The project directory
|
|
* `--repo TEXT`: Install templates from a specific github repo instead
|
|
* `--branch TEXT`: Install templates from a specific branch
|
|
* `--help`: Show this message and exit.
|
|
|
|
### `langchain app new`
|
|
|
|
Create a new LangServe application.
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain app new [OPTIONS] NAME
|
|
```
|
|
|
|
**Arguments**:
|
|
|
|
* `NAME`: The name of the folder to create [required]
|
|
|
|
**Options**:
|
|
|
|
* `--package TEXT`: Packages to seed the project with
|
|
* `--help`: Show this message and exit.
|
|
|
|
### `langchain app remove`
|
|
|
|
Removes the specified package from the current LangServe app.
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain app remove [OPTIONS] API_PATHS...
|
|
```
|
|
|
|
**Arguments**:
|
|
|
|
* `API_PATHS...`: The API paths to remove [required]
|
|
|
|
**Options**:
|
|
|
|
* `--help`: Show this message and exit.
|
|
|
|
### `langchain app serve`
|
|
|
|
Starts the LangServe app.
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain app serve [OPTIONS]
|
|
```
|
|
|
|
**Options**:
|
|
|
|
* `--port INTEGER`: The port to run the server on
|
|
* `--host TEXT`: The host to run the server on
|
|
* `--app TEXT`: The app to run, e.g. `app.server:app`
|
|
* `--help`: Show this message and exit.
|
|
|
|
## `langchain serve`
|
|
|
|
Start the LangServe app, whether it's a template or an app.
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain serve [OPTIONS]
|
|
```
|
|
|
|
**Options**:
|
|
|
|
* `--port INTEGER`: The port to run the server on
|
|
* `--host TEXT`: The host to run the server on
|
|
* `--help`: Show this message and exit.
|
|
|
|
## `langchain template`
|
|
|
|
Develop installable templates.
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain template [OPTIONS] COMMAND [ARGS]...
|
|
```
|
|
|
|
**Options**:
|
|
|
|
* `--help`: Show this message and exit.
|
|
|
|
**Commands**:
|
|
|
|
* `new`: Creates a new template package.
|
|
* `serve`: Starts a demo app for this template.
|
|
|
|
### `langchain template new`
|
|
|
|
Creates a new template package.
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain template new [OPTIONS] NAME
|
|
```
|
|
|
|
**Arguments**:
|
|
|
|
* `NAME`: The name of the folder to create [required]
|
|
|
|
**Options**:
|
|
|
|
* `--with-poetry / --no-poetry`: Don't run poetry install [default: no-poetry]
|
|
* `--help`: Show this message and exit.
|
|
|
|
### `langchain template serve`
|
|
|
|
Starts a demo app for this template.
|
|
|
|
**Usage**:
|
|
|
|
```console
|
|
$ langchain template serve [OPTIONS]
|
|
```
|
|
|
|
**Options**:
|
|
|
|
* `--port INTEGER`: The port to run the server on
|
|
* `--host TEXT`: The host to run the server on
|
|
* `--help`: Show this message and exit.
|