Skip to content

README.md

Latest commit

 

History

History
110 lines (68 loc) · 2.94 KB

README.md

File metadata and controls

110 lines (68 loc) · 2.94 KB
Agentuity
Build Agents, Not Infrastructure

Deploy with Agentuity

🤖 Bun Codey Agent

This is a simple agent that can help you with understanding source code and answering questions about it and performing tasks related to it.

📋 Prerequisites

Before you begin, ensure you have the following installed:

  • Bun: Version 1.2.4 or higher

The .env.example file has examples of the environment variables you need to set in your local .env file. If you're importing this project into Agentuity, copy the .env.example file to .env and then run agentuity project import.

🚀 Getting Started

Authentication

Before using Agentuity, you need to authenticate:

agentuity login

This command will open a browser window where you can log in to your Agentuity account.

Creating a New Agent

To create a new agent in your project:

agentuity agent new

Follow the interactive prompts to configure your agent.

Development Mode

Run your project in development mode with:

agentuity dev

This will start your project and open a new browser window connecting your Agent to the Agentuity Console in Live Mode, allowing you to test and debug your agent in real-time.

🌐 Deployment

When you're ready to deploy your agent to the Agentuity Cloud:

agentuity deploy

This command will bundle your agent and deploy it to the cloud, making it accessible via the Agentuity platform.

📚 Project Structure

├── agents/             # Agent definitions and implementations
├── node_modules/       # Dependencies
├── .agentuity/         # Agentuity configuration files
├── package.json        # Project dependencies and scripts
└── agentuity.yaml      # Agentuity project configuration

🔧 Configuration

Your project configuration is stored in agentuity.yaml. This file defines your agents, development settings, and deployment configuration.

🛠️ Advanced Usage

Environment Variables

You can set environment variables for your project:

agentuity env set KEY=VALUE

Secrets Management

For sensitive information, use secrets:

agentuity env set --secret KEY=VALUE

📖 Documentation

For comprehensive documentation on the Agentuity JavaScript SDK, visit: https://agentuity.dev/SDKs/javascript

🆘 Troubleshooting

If you encounter any issues:

  1. Check the documentation
  2. Join our Discord community for support
  3. Contact the Agentuity support team

📝 License

This source code is free to use and modify under the terms of the MIT license.