langchain/libs/cli/DOCS.md
Erick Friis 47070b8314
CLI (#12284)
Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2023-10-25 11:06:58 -07:00

214 lines
3.3 KiB
Markdown

# `langchain`
**Usage**:
```console
$ langchain [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--help`: Show this message and exit.
**Commands**:
* `hub`: Manage installable hub packages.
* `serve`: Manage LangServe application projects.
* `start`: Start the LangServe instance, whether it's...
## `langchain hub`
Manage installable hub packages.
**Usage**:
```console
$ langchain hub [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--help`: Show this message and exit.
**Commands**:
* `new`: Creates a new hub package.
* `start`: Starts a demo LangServe instance for this...
### `langchain hub new`
Creates a new hub package.
**Usage**:
```console
$ langchain hub new [OPTIONS] NAME
```
**Arguments**:
* `NAME`: [required]
**Options**:
* `--help`: Show this message and exit.
### `langchain hub start`
Starts a demo LangServe instance for this hub package.
**Usage**:
```console
$ langchain hub start [OPTIONS]
```
**Options**:
* `--port INTEGER`
* `--host TEXT`
* `--help`: Show this message and exit.
## `langchain serve`
Manage LangServe application projects.
**Usage**:
```console
$ langchain serve [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--help`: Show this message and exit.
**Commands**:
* `add`: Adds the specified package to the current...
* `install`
* `list`: Lists all packages in the current...
* `new`: Create a new LangServe application.
* `remove`: Removes the specified package from the...
* `start`: Starts the LangServe instance.
### `langchain serve add`
Adds the specified package to the current LangServe instance.
e.g.:
langchain serve add simple-pirate
langchain serve add git+ssh://git@github.com/efriis/simple-pirate.git
langchain serve add git+https://github.com/efriis/hub.git#devbranch#subdirectory=mypackage
**Usage**:
```console
$ langchain serve add [OPTIONS] DEPENDENCIES...
```
**Arguments**:
* `DEPENDENCIES...`: [required]
**Options**:
* `--api-path TEXT`
* `--project-dir PATH`
* `--help`: Show this message and exit.
### `langchain serve install`
**Usage**:
```console
$ langchain serve install [OPTIONS]
```
**Options**:
* `--help`: Show this message and exit.
### `langchain serve list`
Lists all packages in the current LangServe instance.
**Usage**:
```console
$ langchain serve list [OPTIONS]
```
**Options**:
* `--help`: Show this message and exit.
### `langchain serve new`
Create a new LangServe application.
**Usage**:
```console
$ langchain serve new [OPTIONS] NAME
```
**Arguments**:
* `NAME`: [required]
**Options**:
* `--package TEXT`
* `--help`: Show this message and exit.
### `langchain serve remove`
Removes the specified package from the current LangServe instance.
**Usage**:
```console
$ langchain serve remove [OPTIONS] API_PATHS...
```
**Arguments**:
* `API_PATHS...`: [required]
**Options**:
* `--help`: Show this message and exit.
### `langchain serve start`
Starts the LangServe instance.
**Usage**:
```console
$ langchain serve start [OPTIONS]
```
**Options**:
* `--port INTEGER`
* `--host TEXT`
* `--help`: Show this message and exit.
## `langchain start`
Start the LangServe instance, whether it's a hub package or a serve project.
**Usage**:
```console
$ langchain start [OPTIONS]
```
**Options**:
* `--port INTEGER`
* `--host TEXT`
* `--help`: Show this message and exit.