Skip to content

A writing tool for markdown documents featuring built-in AI assistance.

License

Notifications You must be signed in to change notification settings

szilarddoro/allein

Repository files navigation

Allein

Allein logo

Markdown editor with built-in Ollama support

Intelligent auto-completion while working locally.


What Makes Allein Special

  • Smart inline suggestions - AI-powered writing assistance directly in your editor
  • One-click text improvements - Polish your writing with a single action
  • Local-first - Works offline, all your files stay on your computer
  • No account needed - Start writing immediately, no setup or tracking

Getting Started

Setup

This project uses mise to manage required tools (Node.js, pnpm, Rust). If you haven't installed mise yet:

# Install mise (macOS/Linux)
curl https://mise.run | sh

Then clone and get developing:

# Clone the repo
git clone https://github.com/szilarddoro/allein.git
cd allein

# Install tools (versions from mise.toml)
mise install

# Install project dependencies
pnpm install

Development

# Start dev server with hot reload
pnpm tauri dev

Building

# Build native executable for your platform
pnpm tauri build

AI-Powered Writing Suggestions

Allein integrates with Ollama to bring AI writing assistance directly into your editor. Everything runs locally—your writing never leaves your machine.

Setup Ollama

First, install and start Ollama on your machine:

  1. Install Ollama

    # macOS
    brew install ollama
    
    # or download from ollama.ai for Windows/Linux
  2. Start Ollama server

    ollama serve

Download and Configure Models

You can download and configure models in two ways:

Option 1: Use the App Onboarding

Simply start Allein and go through the onboarding flow—the app will guide you through downloading and configuring models directly in the UI.

Option 2: Download via Terminal

Download the recommended models for different features:

# For smart auto-completion suggestions
ollama pull codellama:7b-code

# For text improvement features
ollama pull gemma3:latest

Then configure them in Allein settings. The app will auto-detect your Ollama server at http://localhost:11434 (or you can customize the URL if your server is running on a different host/port).

That's it. You now have AI-powered writing suggestions running entirely on your computer.

Contributing

We'd love your help making Allein better! Whether it's bug fixes, features, or documentation, every contribution matters.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

MIT License - see the LICENSE file for details.

About

A writing tool for markdown documents featuring built-in AI assistance.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Contributors 2

  •  
  •