nixopus/nixopus-docs

Nixopus Documentation Lookup

When you need to answer questions about Nixopus — features, setup, configuration, API, guides, concepts, self-hosting, extensions, domains, deployments, or any product-level detail — always fetch the latest documentation instead of relying on memory.

When to Use

• User asks "how does X work in Nixopus?"
• User asks about configuration, environment variables, or setup
• User references a Nixopus feature you're unsure about
• User asks about self-hosting, cloud, billing, teams, or extensions
• User needs API reference or endpoint details
• You need to explain a Nixopus concept (deployments, domains, organizations, auth)
• Whenever you're about to describe Nixopus behavior and aren't 100% certain from tool results

IMPORTANT — How to Fetch Docs

These are runtime tools, NOT files inside this skill. Do NOT use skill_read or skill_search to look up docs.

To fetch a doc page:

1. Run search_tools("nixopus docs") to find the tool.
2. Run load_tool("fetch_nixopus_docs_page") to load it.
3. Call fetch_nixopus_docs_page({ path: "concepts/deployments.md" }) with the page path from the index below.

You do NOT need to call fetch_nixopus_docs_index — the full index is embedded below.

Docs Index

Source: https://docs.nixopus.com/llms.txt

Getting Started

• Introduction — How Nixopus works and what you can do with it.
• Quickstart — Deploy your first app on Nixopus Cloud.

Concepts

• Authentication — How users and services authenticate with Nixopus.
• Deployments — How Nixopus builds and deploys your apps.
• Domains — How Nixopus handles routing, SSL, and custom domains.
• Organizations — Manage teams and access control.

Guides

• AI chat — Deploy, configure, and troubleshoot with the Nixopus AI agent.
• Charts — Monitor system resources and running services.
• Containers — Manage your running containers.
• Deploy your first app — Go from repo to live in a few clicks.
• Multi-service apps — Deploy multi-service apps with Docker Compose.
• Environment variables — Configure build-time and runtime variables.
• Extensions — Extend Nixopus with the extension marketplace.
• GitHub integration — Connect your repos and enable auto-deploy.
• Health checks — Monitor your apps and catch issues early.
• Notifications — Get alerted about deployments and events.
• Terminal — Access a built-in terminal from the dashboard.

Cloud

• API keys — Create and manage API keys for programmatic access.
• Credits — How credit-based billing works on Nixopus Cloud.
• Custom domains — Connect your own domain to Nixopus Cloud.
• Machines — How machines are provisioned, managed, and scaled.
• Teams — Collaborate with your team on Nixopus Cloud.

Self-Hosting

• Installation — Install Nixopus on your own machine.
• Configuration — Environment variables, ports, firewall, and HTTPS.
• Updating — Keep your self-hosted instance up to date.
• Backup & Restore — Back up and restore your data.
• Branch Preview — Test PRs and branches on a real VPS.
• Management CLI — Manage from the command line.
• Troubleshooting — Common issues and fixes.

Editor Extension

• Overview — Deploy from VS Code or Cursor.
• Installation — Install the Nixopus extension.
• Authentication — Sign in from your editor.
• Deploying — Go live without leaving your editor.
• Workspace sync — Link your workspace to a project.
• Chat interface — Talk to the deploy agent.

API Reference

• Introduction — Interact with Nixopus programmatically.
• OpenAPI spec — Full OpenAPI specification.
• Deploy: delete, deploy, get, update application.
• Domains: list, add, remove, custom domains, DNS check.
• GitHub: connectors, repositories, branches, webhooks.
• Containers: list, get, start, stop, restart, remove, logs, resources.
• MCP: add, delete, list, update, test servers; discover/invoke tools.
• Notifications: SMTP, webhook config; send; preferences.
• Health checks: create, get, update, delete, toggle, stats, results.
• Machines: list, register BYOS, pause, resume, restart, remove, events, metrics, billing, backup.
• Extensions: list, get, fork, delete, run, executions, categories.
• File manager: list, upload, create/copy/move/delete directory.
• User: profile, settings, preferences, avatar, name.
• Other: feature flags, bootstrap, onboarding, updates, audit logs, compose, projects, trail.

Other

• Changelog — Product updates, new features, and bug fixes.
• Contributing — Set up your development environment and contribute.
• Code of Conduct — Community standards.
• License — FSL-1.1-ALv2.

Workflow

1. Find the right page — scan the index above for the page matching the user's question.
2. Fetch it — search_tools("nixopus docs") → load_tool("fetch_nixopus_docs_page") → call with the path.
3. Answer from the content — base your response on the fetched documentation. If one page isn't enough, fetch more.

Rules

• Never fabricate Nixopus features, settings, or API endpoints. If you can't find it in the docs, say so.
• For API reference questions, fetch the specific endpoint page from api-reference/.
• If the user's question spans multiple topics, fetch multiple pages.
• Keep fetched content as context — don't re-fetch the same page in the same conversation.