Introduction

Get started with Helse's developer documentation. Learn how to integrate and use our open-source AI research platform.

Developer Documentation

Welcome to Helse's developer documentation. This guide is for developers who want to use Helse's products open-source Helse CLI, Helse Web and Helse Desktop.

Documentation

Helse CLI

Get started with Helse CLI in minutes. Learn more about the core features and development tools.

Documentation

Helse Web

Learn how to use our web-based AI writing platform for document creation and management.

Documentation

Helse Desktop

Looking for a GUI? Check out our premium desktop application.

Why Choose Helse CLI?

Helse's command-line interface provides powerful features for developers:

API and Integration Support (Coming Soon)

Roadmap:

The following features are part of our development roadmap and will be available soon:

  • RESTful API for full access to Helse's capabilities
  • Custom integration options
  • Automation tools for research workflows

Core Features

FeatureDescription
AI WritingProgrammatic access to writing assistance
Reference ManagementAPI for citation and bibliography handling
Document AnalysisAutomated paper analysis and data extraction

Development Tools

1

CLI Tools

  • Command-line research assistant
  • Build automation scripts
  • Custom workflow creation
2

API Access

  • RESTful endpoints (Coming Soon)
  • WebSocket support (Coming Soon)
  • Authentication handling (Coming Soon)
3

Integration

  • Editor plugins (Coming Soon)
  • CI/CD pipelines (Coming Soon)
  • Custom applications (Coming Soon)

Getting Started

To begin using Helse CLI, you'll need:

Requirements:

  • An OpenAI API key
  • Node.js installed on your system
  • Basic command-line knowledge

Head over to the Quick Start Guide to begin development with Helse.

Desktop Application

If you prefer a graphical interface with additional features:

  • Visit helse.ai to learn more
  • Download the desktop application
  • Purchase a subscription for premium features

Open Source

The CLI version of Helse is proudly open source and free to use. We believe in making powerful research tools accessible to developers while offering a premium experience for users who prefer a graphical interface.

Join Our Community

Get involved with Helse development:

title: Deployment Guide description: Learn how to deploy and self-host Helse keywords: deployment, self-hosting, installation, setup

Deployment Guide

This guide will walk you through the process of deploying and self-hosting Helse.

Prerequisites

Before you begin, ensure you have:

  • Node.js 18 or higher installed
  • Git installed
  • A Supabase account
  • Your preferred code editor (VS Code recommended)

Step 1: Clone the Repository

git clone https://github.com/yourusername/helse.git
cd helse

Step 2: Environment Setup

  1. Copy the example environment file:
cp .env.example .env.local
  1. Fill in your environment variables:
  • NEXT_PUBLIC_SUPABASE_URL: Your Supabase project URL
  • NEXT_PUBLIC_SUPABASE_ANON_KEY: Your Supabase anonymous key

Step 3: Install Dependencies

npm install
# or
yarn install

Step 4: Database Setup

  1. Create a new Supabase project
  2. Run the database migrations from the supabase/migrations folder
  3. Set up the necessary database policies

Step 5: Build and Deploy

For development:

npm run dev
# or
yarn dev

For production:

npm run build
npm start
# or
yarn build
yarn start

Additional Configuration

  • Configure authentication providers
  • Set up storage buckets if needed
  • Configure API rate limiting
  • Set up monitoring and logging

Security Considerations

  • Keep your environment variables secure
  • Regularly update dependencies
  • Follow security best practices
  • Monitor for suspicious activities

Need help? Join our community Discord or check our GitHub discussions.