Documentation

Complete guide to getting started with Doclific

Installation

Quick Install
Install Doclific with a single command
curl -fsSL https://raw.githubusercontent.com/muellerluke/doclific/main/scripts/install.sh | bash

This will download the latest release for your platform, install the binary to/usr/local/bin(or ~/.local/bin if you don't have write permissions), and set up the frontend build files.

Note: Make sure ~/.local/bin(or /usr/local/bin) is in your PATH if it's not already.

Commands

Configuration

Config File Location
Doclific stores configuration in ~/.config/doclific/config.json

You can manage it using the get and set commands, or edit the file directly.

Setting up AI
Configure AI-powered documentation generation

Current Status: Doclific currently supports Google's Gemini AI models. Support for OpenAI and Anthropic is planned for future releases.

To use AI-powered documentation generation, configure Google AI:

# Set your Google API key (required)
doclific set GOOGLE_API_KEY your-api-key-here

# The provider defaults to "google", but you can explicitly set it:
doclific set AI_PROVIDER google

# Set the model (optional, defaults to gemini-3-flash-preview)
doclific set AI_MODEL gemini-3-flash-preview

Future Support: OpenAI and Anthropic providers will be supported in upcoming releases. The configuration keys (OPENAI_API_KEY,ANTHROPIC_API_KEY) are already available for future use.

Key Features

ERD Diagramming
Create Entity Relationship Diagrams to visualize your database schema

Doclific includes powerful ERD diagramming capabilities. You can create detailed Entity Relationship Diagrams directly within your documentation. The AI assistant can help generate ERDs based on your codebase structure, making it easy to visualize database relationships and schema designs.

Whiteboarding
Document architecture and system designs with interactive whiteboards

Use the built-in whiteboarding feature to create visual architecture diagrams, system designs, and flowcharts. Perfect for documenting complex systems, planning new features, and visualizing how different components interact in your codebase.

Usage

Quick Start Guide

  1. Initialize a project:

    cd /path/to/your/project
    doclific init

  2. Start the server:

    doclific

  3. Open the web interface: The browser will open automatically, or navigate to http://localhost:6767

  4. Create documentation: Use the Notion-like editor to create and edit your documentation. Use the slash menu (/) to add blocks, ERD diagrams, whiteboards, and more to visualize your architecture.

  5. Use AI assistance: Select AI options from the slash menu (/) in the editor to generate documentation, ERDs, and diagrams using AI

Project Structure

Documentation Folder Structure
After running doclific init, your project will have:
your-project/
└── doclific/
    └── [documentation folders]/
        ├── config.json
        └── content.mdx

Each documentation folder contains:

  • config.json: Metadata (title, icon)
  • content.mdx: The documentation content in MDX format

Demo

Video tutorial or walkthrough placeholder

Add a video demonstrating Doclific's features here

Ready to get started?

Install Doclific and start documenting your codebase today

Back to HomeView on GitHub