Skip to content

Commit

Permalink
Tj202/pr readme (#41)
Browse files Browse the repository at this point in the history
* Adding notice

* Removed wrong notice

* Adding analytics view

* Updated readme

* removed view

---------

Co-authored-by: Thejas N U <[email protected]>
  • Loading branch information
TJ202 and ThejasNU authored Jan 16, 2025
1 parent 0fd86da commit 0892c4d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ The mono-repo for the Couchbase Agent Catalog project.
git clone [email protected]:couchbaselabs/agent-catalog.git
```

3. You are now ready to install the Agent Catalog package!
3. You are now ready to install the Agent Catalog package! We recommend using Anaconda to create a virtual environment
for your project to ensure no global dependencies interfere with the project.
Using your project's Python environment, execute the following command to install a local package with `pip`:

```bash
Expand All @@ -45,6 +46,11 @@ The mono-repo for the Couchbase Agent Catalog project.
# Install the agentc package.
pip install libs/agentc
```
If you are interested in developing with langchain, also install `agentc_langchain` by running the following:

```bash
pip install libs/agentc_langchain
```

If you are interested in building a ``.whl`` file (for later use in ``.whl``-based installs), use :command:`poetry`
directly:
Expand Down Expand Up @@ -107,12 +113,12 @@ Commands:
execute Search and execute a specific tool.
find Find items from the catalog based on a natural language QUERY string or by name.
index Walk the source directory trees (SOURCE_DIRS) to index source files into the local catalog.
ls List all tools or prompts in the catalog.
publish Upload the local catalog to a Couchbase instance.
ls List all indexed tools and/or prompts in the catalog.
publish Upload the local catalog and/or logs to a Couchbase instance.
status Show the status of the local catalog.
version Show the current version of agentc.

See: https://docs.couchbase.com for more information.
See: https://docs.couchbase.com or https://couchbaselabs.github.io/agent-catalog/index.html# for more information.
```

If you see the output above, you are all set! Head on over to our [docs](https://couchbaselabs.github.io/agent-catalog/) or our [templates](templates) to start
Expand Down
2 changes: 1 addition & 1 deletion libs/agentc_cli/agentc_cli/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ def resolve_command(self, ctx, args):

@click.group(
cls=AliasedGroup,
epilog="See: https://docs.couchbase.com for more information.",
epilog="See: https://docs.couchbase.com or https://couchbaselabs.github.io/agent-catalog/index.html# for more information.",
context_settings=dict(max_content_width=800),
)
@click.option(
Expand Down
2 changes: 1 addition & 1 deletion templates/agents/with_controlflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This directory contains a starter project for building agents with Couchbase, Co
status Show the status of the local catalog.
version Show the current version of agentc.

See: https://docs.couchbase.com for more information.
See: https://docs.couchbase.com or https://couchbaselabs.github.io/agent-catalog/index.html# for more information.
```

6. Make sure your Git repo is clean, and run `agentc index` to index your tools and prompts.
Expand Down

0 comments on commit 0892c4d

Please sign in to comment.