Skip to content

quick start

Niladri Das edited this page Aug 19, 2025 · 1 revision

Quick Start Guide

Get up and running with Harper in minutes!

First-Time Setup

  1. Install Harper (if not already installed):

    cargo install harper-ai
  2. Configure your API key:

    mkdir -p ~/.config/harper
    echo "OPENAI_API_KEY=your_api_key_here" > ~/.config/harper/config.toml

    Or use the interactive setup:

    harper setup

Basic Usage

Starting a New Session

harper

Chat with the AI

Simply type your message and press Enter:

Hello! How can I help you today?

Execute Shell Commands

Prefix commands with ! to execute them:

!ls -la

Web Search

Perform web searches with:

/search What's the weather like today?

Save and Load Conversations

/save my_conversation
/load my_conversation

Example Workflow

  1. Start Harper:

    harper
  2. Ask a question:

    How do I list all files in a directory sorted by size?
    
  3. Execute the suggested command:

    !ls -laSh
    
  4. Save your session:

    /save my_work
    

Next Steps

Clone this wiki locally