Neoman
Equip your AI Agents with Internal/Enterprise Docs

A modern documentation retriever and reader inspired by Unix man pages.
Read, search, and serve documentation locally — built for AI-assisted development workflows.

Overview • Features • Installation • Quickstart • Usage • Adopting Neoman • Contributing

---

Note

Neoman is currently in early development. Expect frequent updates and changes as we refine the experience.

Overview

Neoman brings the simplicity of Unix man pages to modern software documentation. Docs stays in your Git repositories. Neoman fetches, indexes, and serves it locally. No external servers, no hosting costs, no data leaving your machine.

Features

Available Now

• Local & Safe — Runs and stays on your device. Perfect for private org documentations.

• Documentation Hub — All your org's internal documentations in one local searchable place.

• Git-Native Workflow — Documentation syncs with your code. Push to any Git provider (GitHub, GitLab, etc.).

• Practical Convention — A /docs directory with .md files is all you need.

• Zero-Deployment — No servers to maintain. Write Markdown, push to a Git provider, done.

Coming Soon

• Semantic Search — Query using natural language. Get relevance-ranked results with preview snippets.

• Agentic Context Retrieval — Retrieve relevant up-to-date documentation context for coding agents and AI assistants.

Installation

Requirements

• Go 1.22 or later
• macOS or Linux

Build from Source

git clone https://github.com/inodaf/neoman.git
cd neoman
make all

The binaries will be created in ./bin/:

• ./bin/nman — CLI client
• ./bin/nmand — Daemon server

Add to your PATH:

export PATH="$PATH:$(pwd)/bin"

Quickstart

Start using Neoman immediately:

nman inodaf/neoman

This launches a terminal interface for browsing the Neoman documentation — using Neoman itself.

Usage

Open Documentation

nman a-github-user/repo-name # E.g. nman vercel/next.js

Opens an interactive terminal interface for navigating through the documentation.

List Documentation

# All available projects
nman list

# Projects in an organization
nman list <author>

# Documents in a project
nman list <author>/<project>

View a Specific Document

nman view author/project "path/to/document.md"

For detailed usage, run nman inodaf/neoman or visit the documentation.

Adopting Neoman

Make your project's documentation available through Neoman in few steps:

1. Create a /docs directory in your repository root
2. Add additional .md files for your documentation pages
3. Add an index.md file as your documentation front-page (optional)
4. Push to your Git provider (GitHub, GitLab, etc.)

Example structure:

your-repo/
├── docs/
│   ├── index.md
│   ├── getting-started.md
│   ├── api-reference.md
│   └── guides/
│       ├── authentication.md
│       └── deployment.md
├── src/
└── README.md

Your documentation is now accessible via:

nman your-username/your-repo

For authoring guidelines, see docs/Authoring Docs/.

Contributing

We welcome contributions! Here's how to get started:

1. Review the Architecture documentation
2. Check out Coding Conventions

See docs/Internals/ for more details.

Get in Touch

• GitHub Issues — Report bugs or request features
• GitHub Discussions — Ask questions and share ideas

License

MIT License — see LICENSE for details.