MCPcopy Index your code
hub / github.com/GitbookIO/nuts

github.com/GitbookIO/nuts @3.1.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release 3.1.1 ↗ · + Follow
23 symbols 33 edges 14 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Nuts

Nuts is a simple (and smart) application to serve desktop-application releases.

Schema

It uses GitHub as a backend to store assets, and it can easily be deployed to Heroku as a stateless service. It supports GitHub private repositories (useful to store releases of a closed-source application available on GitHub).

Deploy

Features

  • :sparkles: Store assets on GitHub releases
  • :sparkles: Proxy releases from private repositories to your users
  • :sparkles: Simple but powerful download urls
    • /download/latest
    • /download/latest/:os
    • /download/:version
    • /download/:version/:os
    • /download/channel/:channel
    • /download/channel/:channel/:os
  • :sparkles: Support pre-release channels (beta, alpha, ...)
  • :sparkles: Auto-updates with Squirrel
    • For Mac using /update?version=<x.x.x>&platform=osx
    • For Windows using Squirrel.Windows and Nugets packages
  • :sparkles: Private API
  • :sparkles: Use it as a middleware: add custom analytics, authentication
  • :sparkles: Serve the perfect type of assets: .zip for Squirrel.Mac, .nupkg for Squirrel.Windows, .dmg for Mac users, ...
  • :sparkles: Release notes endpoint
    • /notes/:version
  • :sparkles: Up-to-date releases (GitHub webhooks)
  • :sparkles: Atom/RSS feeds for versions/channels

Deploy it / Start it

Follow our guide to deploy Nuts.

Auto-updater / Squirrel

This server provides an endpoint for Squirrel auto-updater, it supports both OS X and Windows.

Documentation

Check out the documentation for more details.

Core symbols most depended-on inside this repo

hasSuffix
called by 7
lib/utils/platforms.js
getFullUrl
called by 3
lib/nuts.js
cleanup
called by 2
lib/backends/backend.js
unauthorized
called by 2
bin/web.js
normalizeTag
called by 1
lib/versions.js
extractChannel
called by 1
lib/versions.js
detectPlatform
called by 1
lib/utils/platforms.js
hashPrerelease
called by 1
lib/utils/win-releases.js

Shape

Function 23

Languages

TypeScript100%

Modules by API surface

lib/versions.js5 symbols
lib/utils/win-releases.js5 symbols
lib/utils/platforms.js5 symbols
lib/backends/backend.js3 symbols
lib/nuts.js2 symbols
lib/utils/notes.js1 symbols
lib/backends/github.js1 symbols
bin/web.js1 symbols

For agents

$ claude mcp add nuts \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact