Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A cool toolkit for Nim developers!

nimble install clue

API reference
Github Actions Github Actions

Why Clue?

Because sometimes I have no damn clue how to... 😂

Clue is an alternative to nimble — a friendly toolkit for installing, building and documenting Nim packages, resolving tricky dependencies, and managing per-version toolchains with virtual environments when nimble just doesn't cut it.

😍 Key Features

  • Package management — cached version discovery, transitive dependency resolution, feature flags, SSH installs & orphan pruning
  • Build the current package from its nimble file (--release, --debug, --features)
  • Install / uninstall / dump / versions / prune with a local package registry
  • Virtual environments (venv) for per-version Nim toolchains via choosenim
  • Local documentation — build & browse versioned nim doc output right from the command line

Note

Clue used to be the home for generating native extensions, C wrappers and OpenAPI 3.x clients. That codebase now lives in nimbase and ships as the nimbase package. Clue stays focused on making local package management a joy.

Usage

Package Management

# Build the current package from its nimble file
clue build
clue build --release
clue build --features:ssl,jwt

# Install / uninstall packages from the registry
clue install spry
clue install spry@1.2.0
clue install ssl#master
clue install https://github.com/user/repo
clue uninstall spry

# Inspect the registry
clue dump spry
clue versions spry --refresh
clue prune

Environment Management

# Create a virtual environment pinned to a specific Nim version
clue venv --nim:2.2.0

source .env/activate     # or: source .env/deactivate

Documentation

# Build local documentation for a package
clue docs gen spry

# Open the built docs in your browser
clue docs open spry

Documentation Builder

Clue offers a local documentation generator built on top of the built-in Nim doc system. Because most of the time package authors focus on writing code and don't provide an easy way to access documentation for their packages, Clue lets you build & open docs for any local package right from the terminal.

  • Versioned nim doc output stored under ~/.clue
  • Auto-generated overview page for everything you've documented
  • clue docs open <pkg> gets you straight to the latest build

Roadmap

  • Docs — LLM integration for RAG over your local documentation
  • Docs — generate a local search index for command-line discovery

❤ Contributions & Support

OpenCode Switch to Open-Source LLMs via OpenCode GO, choosing from a variety of powerful models such as DeepSeek, Qwen, Kimi, GLM-5, MiniMax, MiMo. 🍕 Use our referral link to get started!

🎩 License

Clue | MIT license. Made by humans from OpenPeeps.
Copyright OpenPeeps & Contributors — All rights reserved.

About

A cool toolkit for Nim! Local documentation, API bindings, Plugin, Wrapper and OpenAPI 3.0 code generators

Topics

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

Generated from openpeeps/pistachio