Get Started with agentregistry

Follow this guide to install agentregistry, create your first AI artifact, and publish it to the registry.

1

Installation

Install the agentregistry CLI tool using pip:

pip install agentregistry

Verify the installation:

agentregistry --version
2

Authentication

Log in to your agentregistry account:

agentregistry login

This will prompt you for your credentials and store an authentication token locally.

3

Create Your First Artifact

Initialize a new artifact project:

agentregistry init my-first-agent

This creates a new directory with a template structure. Navigate to the directory:

cd my-first-agent

The generated structure includes configuration files and example code to get you started quickly.

4

Test Locally

Run your artifact locally to test it:

agentregistry run

This launches your artifact in a local development environment where you can test and debug before publishing.

5

Publish to Registry

Once you are satisfied with your artifact, publish it to the registry:

agentregistry publish

Your artifact is now available in the registry for others to discover and use.

6

Pull and Run Artifacts

Pull an artifact from the registry:

agentregistry pull username/artifact-name

Run the pulled artifact:

agentregistry run username/artifact-name

Next Steps

Join the agentregistry community and contribute to the future of AI development.