Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
115 lines (91 loc) · 3.22 KB

DEVELOPMENT.md

File metadata and controls

115 lines (91 loc) · 3.22 KB

Development

Quick Start

Docker (When you just want to have a quick try)

If you decide you want to contribute to IntentKit, skip this section and run the code in your local development environment.

  1. Install Docker.

  2. Create a new directory and navigate into it:

mkdir intentkit && cd intentkit
  1. Download the required files:
# Download docker-compose.yml
curl -O https://raw.githubusercontent.com/crestalnetwork/intentkit/main/docker-compose.yml

# Download example environment file
curl -O https://raw.githubusercontent.com/crestalnetwork/intentkit/main/example.env
  1. Set up environment:
# Rename example.env to .env
mv example.env .env

# Edit .env file and add your configuration
# Make sure to set OPENAI_API_KEY
  1. Start the services:
docker compose up

This will block current terminal to show logs, you can press Ctrl+C to stop it. When you want to run other command, you can open another terminal.

  1. Try it out:
curl "http://127.0.0.1:8000/debug/example/chat?q=Hello"

In terminal, curl cannot auto escape special characters, so you can use browser to test. Just copy the URL to your browser, replace "Hello" with your words.

  1. Manage your agent: When intentkit first starts, it will create an example agent for you. You can manage your agent by using the scripts in the scripts directory.
cd scripts
# Export agent
sh export.sh example
# Import agent
sh import.sh example
# Create another agent
sh create.sh my_agent

Local Development

  1. Clone the repository:
git clone https://github.com/crestalnetwork/intentkit.git
cd intentkit
  1. Set up your environment:

If you haven't installed uv, please install it first. You don't need to worry about your Python version and venv; uv will automatically handle everything for you.

uv sync
  1. Configure your environment:

Read Configuration for detailed settings. Then create your local .env file.

cp example.env .env
# Edit .env with your configuration
# OPENAI_API_KEY and DB_* are required
  1. Run the application:
# Run the API server in development mode
uvicorn app.api:app --reload

# There are many other services, like autonomous agent scheduler, you can try them later
# python -m app.autonomous
  1. Try it out:
curl "http://127.0.0.1:8000/debug/example/chat?q=Hello"

In terminal, curl cannot auto escape special characters, so you can use browser to test. Just copy the URL to your browser, replace "Hello" with your words.

  1. Manage your agent: When intentkit first starts, it will create an example agent for you. You can manage your agent by using the scripts in the scripts directory.
cd scripts
# Export agent
sh export.sh example
# Import agent
sh import.sh example
# Create another agent
sh create.sh my_agent

What's Next

More about the agent management, check out Agent Management.

You can visit the API Docs to learn more.

You may want to contribute skills, check out Skill Contributing.