Getting Started with Reminix

Welcome to Reminix! This guide will walk you through deploying your first AI agent in under 5 minutes.

💡 Info
This guide assumes you have basic knowledge of JavaScript/TypeScript and Git. If you're new to these technologies, check out our Examples section first.

What is Reminix?

Reminix is a platform that allows you to deploy AI agents instantly. Write your handler, push with CLI, and your agent is live. No infrastructure, no complexity.

Prerequisites

Before you begin, make sure you have:

Node.js 18+ installed
A GitHub account
Basic knowledge of JavaScript/TypeScript

Installation

Install the Reminix CLI globally:

Install CLI:

$ npm install -g @reminix/cli

shell

Verify the installation:

$ reminix --version

shell

Authentication

$ reminix login

shell

This will open your browser and prompt you to authenticate with GitHub.

Create Your First Agent

Create a new project:

$ reminix create my-first-agent
$ cd my-first-agent

shell

This creates a new directory with the following structure:

Project Structure:

my-first-agent/
├── handler.ts          # Your agent logic
├── package.json        # Dependencies
├── reminix.json        # Configuration
└── README.md          # Documentation

Write Your Handler

Open handler.ts and replace the default content:

handler.ts:

import { AgentHandler } from '@reminix/types'

export const handler: AgentHandler = async (input) => {
  const { message, context } = input
  
  // Your agent logic here
  const response = `Hello! You said: "${message}"`
  
  return {
    response,
    metadata: {
      timestamp: new Date().toISOString(),
      agent: 'my-first-agent'
    }
  }
}

typescript

Deploy Your Agent

Deploy your agent to Reminix:

$ reminix deploy

shell

✅ Success
🎉 Congratulations! Your agent is now live and accessible via the Reminix platform.

Test Your Agent

You can test your agent in several ways:

Dashboard: Visit your Reminix Dashboard and test your agent
API: Use the REST API to send requests
CLI: Test directly from the command line

Test via CLI:

$ reminix test "Hello, world!"

shell

Next Steps

Now that you have your first agent deployed, explore these resources:

API Reference - Learn about the Reminix API
Examples - See more complex agent examples
Configuration - Customize your agent settings
Deployment - Learn about different deployment options

⚠️ Warning
Remember to keep your API keys secure and never commit them to version control.

Getting Help

If you run into any issues:

Check our FAQ
Join our Discord community
Open an issue on GitHub
Contact support at support@reminix.com