Getting Started
Quick start guides and tutorials to get you up and running with the Peregrine platform
Quick Start Guide
Get started with Peregrine in under 30 minutes. This guide will walk you through the initial setup, authentication, and your first API calls.
Prerequisites
- AWS GovCloud account with appropriate permissions
- Docker installed on your local machine
- Node.js 18+ and npm/yarn
- Valid Peregrine license key
1. Clone the Repository
git clone https://github.com/peregrinetec/peregrine-platform.git
cd peregrine-platform2. Configure Environment
cp .env.example .env
# Edit .env with your configuration3. Start the Platform
docker-compose up -d
Installation & Setup
Local Development Setup
Set up your local development environment for building and testing Peregrine applications.
Install Dependencies
npm install or yarn install in the project root
Configure Database
Set up PostgreSQL and run migrations
Start Development Server
npm run dev to start the development environment
Production Deployment
Deploy Peregrine to AWS GovCloud for production use.
Infrastructure Setup
- • VPC and networking configuration
- • ECS cluster setup
- • RDS database provisioning
- • Load balancer configuration
Security Configuration
- • IAM roles and policies
- • Security groups
- • SSL/TLS certificates
- • Secrets management
Your First AI Agent
Create your first AI agent to automate healthcare workflows. This example shows how to build an agent that processes patient intake forms.
import { PeregrineAgent } from '@peregrine/sdk';
const intakeAgent = new PeregrineAgent({
name: 'Patient Intake Assistant',
model: 'gpt-4',
prompt: 'Process patient intake forms and extract key information'
});
// Define the agent's capabilities
intakeAgent.addCapability('extractDemographics');
intakeAgent.addCapability('identifyConditions');
intakeAgent.addCapability('flagUrgentCases');
// Process a patient form
const result = await intakeAgent.process({
document: patientForm,
outputFormat: 'FHIR'
});
console.log(result.patient);Basic Configuration
Environment Variables
Essential environment variables for configuring Peregrine:
Configuration Files
peregrine.config.json
Main configuration file for platform settings
models.config.json
AI model configurations and parameters
security.config.json
Security policies and compliance settings
Next Steps
Now that you have Peregrine up and running, explore these resources: