Skip to content

Commit

Permalink
Update readmes with new cli install (langchain-ai#12847)
Browse files Browse the repository at this point in the history
Old command still works. Just simplifying.

Merge after releasing CLI 0.0.15
  • Loading branch information
efriis authored Nov 3, 2023
1 parent 7db49d3 commit 6c23771
Show file tree
Hide file tree
Showing 52 changed files with 52 additions and 52 deletions.
2 changes: 1 addition & 1 deletion libs/cli/langchain_cli/package_template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ TODO: What environment variables need to be set (if any)
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion libs/cli/langchain_cli/project_template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Install the LangChain CLI if you haven't yet

```bash
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

## Adding packages
Expand Down
2 changes: 1 addition & 1 deletion templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ They are all in a standard format which make it easy to deploy them with [LangSe
To use, first install the LangChain CLI.

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

Next, create a new LangChain project:
Expand Down
2 changes: 1 addition & 1 deletion templates/anthropic-iterative-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Set the `ANTHROPIC_API_KEY` environment variable to access the Anthropic models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/cassandra-entomology-rag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The connection parameters and secrets must be provided through environment varia
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/cassandra-synonym-caching/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _Note:_ you can alternatively use a regular Cassandra cluster: to do so, make su
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/csv-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To set up the environment, the `ingest.py` script should be run to handle the in
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Set up an appropriate dev environment, and make sure you are in this `templates`
Make sure you have `langchain-cli` installed.

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

You can then run the following command to create a new skeleton of a package.
Expand Down
2 changes: 1 addition & 1 deletion templates/docs/LAUNCHING_PACKAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This information can be used to launch a LangServe instance automatically.
In order to do this, first make sure the CLI is installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

You can then run:
Expand Down
2 changes: 1 addition & 1 deletion templates/elastic-query-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This will create a `customers` index. In this package, we specify indexes to gen
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/extraction-anthropic-functions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Set the `ANTHROPIC_API_KEY` environment variable to access the Anthropic models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/extraction-openai-functions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/guardrails-output-parser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/hybrid-search-weaviate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You will also need to set your `OPENAI_API_KEY` to use the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/hyde/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/llama2-functions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Ensure that `REPLICATE_API_TOKEN` is set in your environment.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/neo4j-cypher-ft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This script will populate the database with sample movie data and create a full-
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/neo4j-cypher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This script will populate the database with sample movie data.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/neo4j-generation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ NEO4J_PASSWORD=<YOUR_NEO4J_PASSWORD>
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/neo4j-parent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Additionally, a vector index named `retrieval` is created for efficient querying
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/openai-functions-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Set the `TAVILY_API_KEY` environment variable to access Tavily.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/pirate-speak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/plate-chain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To utilize plate-chain, you must have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

Creating a new LangChain project and installing plate-chain as the only package can be done with:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-aws-bedrock/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You should also set the following environment variables to reflect your AWS prof
First, install the LangChain CLI:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-aws-kendra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following environment variables need to be set:
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-chroma-private/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This package also uses [GPT4All](https://python.langchain.com/docs/integrations/
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-chroma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-codellama-fireworks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can obtain it from [here](https://app.fireworks.ai/login?callbackURL=https:/
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-conversation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ docker run -p 9200:9200 -e "discovery.type=single-node" -e "xpack.security.enabl
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-fusion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-matching-engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ME_ENDPOINT_ID
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-momento-vector-index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-mongo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export OPENAI_API_KEY=...
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-pinecone-multi-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first install the LangChain CLI:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this package, do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-pinecone-rerank/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Set the `COHERE_API_KEY` environment variable to access the Cohere ReRank.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-pinecone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ We use a variety of environment variables to configure this application
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-semi-structured/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ brew install tesseract poppler
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-singlestoredb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-supabase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Since we are using [`SupabaseVectorStore`](https://python.langchain.com/docs/int
First, install the LangChain CLI:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-timescale-hybrid-search-time/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rag-weaviate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Also, ensure the following environment variables are set:
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
2 changes: 1 addition & 1 deletion templates/rewrite-retrieve-read/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Set the `OPENAI_API_KEY` environment variable to access the OpenAI models.
To use this package, you should first have the LangChain CLI installed:

```shell
pip install -U "langchain-cli[serve]"
pip install -U langchain-cli
```

To create a new LangChain project and install this as the only package, you can do:
Expand Down
Loading

0 comments on commit 6c23771

Please sign in to comment.