Skip to content

A desktop coding agent with free access to frontier models.

TypeScript
7.5 KB
Raw Blame
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "OmniRush.ai Docs",
  "favicon": "/logo/light.svg",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  },
  "colors": {
    "primary": "#011627",
    "light": "#3b82f6",
    "dark": "#011627"
  },
  "api": {
    "openapi": "openapi.json"
  },
  "navigation": {
    "tabs": [
      {
        "tab": "Start here",
        "pages": [
          "start-here/get-started",
          "start-here/downloads",
          "start-here/pricing-and-licensing",
          "start-here/stewardship",
          "start-here/migrate-from-claude-cowork",
          {
            "group": "Connect your stack",
            "pages": [
              "start-here/connect-your-stack/sign-in-with-chatgpt",
              "start-here/connect-your-stack/add-anthropic-api-key",
              "start-here/connect-your-stack/add-a-custom-llm",
              "start-here/connect-your-stack/connect-services",
              "start-here/connect-your-stack/add-an-mcp-server",
              "start-here/connect-your-stack/enable-exa-search"
            ]
          },
          {
            "group": "Do work with it",
            "pages": [
              "start-here/do-work-with-it/control-the-browser",
              "start-here/do-work-with-it/use-desktop-apps",
              "start-here/do-work-with-it/cross-chat-memory",
              "start-here/do-work-with-it/work-with-excel-workbooks",
              "start-here/do-work-with-it/what-uses-tokens",
              "start-here/do-work-with-it/workflows",
              "start-here/do-work-with-it/skills-plugins-and-mcp",
              "start-here/do-work-with-it/create-a-skill-from-chat",
              "start-here/do-work-with-it/publish-and-copy-a-skill",
              "start-here/do-work-with-it/share-your-setup"
            ]
          },
          {
            "group": "Troubleshooting",
            "pages": [
              "start-here/troubleshooting/diagnostic-prompts"
            ]
          },
          {
            "group": "Help improve OmniRush.ai",
            "pages": [
              "start-here/missing-docs",
              "start-here/missing-languages"
            ]
          }
        ]
      },
      {
        "tab": "Self-host",
        "pages": [
          {
            "group": "Overview",
            "pages": [
              "start-here/self-host",
              "self-host/evaluate-with-docker-compose"
            ]
          },
          {
            "group": "Deploy to your cloud",
            "pages": [
              "self-host/deploy-to-your-cloud/overview",
              "self-host/deploy-to-your-cloud/aws",
              "self-host/deploy-to-your-cloud/azure",
              "self-host/deploy-to-your-cloud/google-cloud",
              "self-host/deploy-to-your-cloud/first-administrator"
            ]
          },
          {
            "group": "Plan your network",
            "pages": [
              "start-here/private-network-deployment",
              "start-here/air-gapped-deployment",
              "start-here/outbound-network-access",
              "start-here/certificate-trust-and-proxies"
            ]
          },
          {
            "group": "Install and operate",
            "pages": [
              "start-here/enterprise-desktop-deployment",
              "self-host/declarative-configuration",
              "start-here/installer-delivery",
              "start-here/on-prem-branding",
              "start-here/github-connector-helm"
            ]
          },
          {
            "group": "Troubleshoot",
            "pages": [
              "start-here/network-diagnostics"
            ]
          }
        ]
      },
      {
        "tab": "Cloud",
        "pages": [
          "cloud/get-started",
          "cloud/team-quickstart",
          {
            "group": "Share with your team",
            "pages": [
              "cloud/share-with-your-team/collections",
              "cloud/share-with-your-team/desktop-policies",
              "cloud/share-with-your-team/team-prompt-cards",
              "cloud/share-with-your-team/managed-llm-provider",
              "cloud/share-with-your-team/per-member-llm-credentials",
              "cloud/share-with-your-team/custom-llm-provider",
              "cloud/share-with-your-team/shared-mcp-connections",
              "cloud/share-with-your-team/dashboards"
            ]
          },
          {
            "group": "Run in the cloud",
            "pages": [
              "cloud/run-in-the-cloud/shared-workspace",
              "cloud/run-in-the-cloud/open-cloud-in-browser"
            ]
          },
          {
            "group": "MCP Gateway",
            "pages": [
              "cloud/run-in-the-cloud/cloud-mcp",
              "model-context-protocol/agent-plugins",
              "model-context-protocol/opencode",
              "model-context-protocol/claude-code",
              "model-context-protocol/codex",
              "model-context-protocol/claude-desktop",
              "model-context-protocol/chatgpt",
              "model-context-protocol/cursor",
              "model-context-protocol/vs-code",
              "model-context-protocol/windsurf",
              "model-context-protocol/zed",
              "model-context-protocol/gemini-cli",
              "cloud/run-in-the-cloud/connect-omnirush-mcp-remote-machine"
            ]
          },
          "cloud/members-and-rbac",
          "cloud/sso-google-workspace",
          "cloud/scim-google-workspace",
          "cloud/sso-okta",
          "cloud/scim-okta",
          "cloud/sso-microsoft-entra",
          "cloud/scim-microsoft-entra",
          "cloud/security-and-operations",
          "cloud/enterprise"
        ]
      },
      {
        "tab": "API",
        "openapi": "/openapi.json"
      },
      {
        "tab": "Roadmap",
        "pages": [
          "roadmap"
        ]
      },
      {
        "tab": "Changelog",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "redirects": [
    {
      "source": "/",
      "destination": "/start-here/get-started"
    },
    {
      "source": "/model-context-protocol",
      "destination": "/cloud/run-in-the-cloud/cloud-mcp"
    },
    {
      "source": "/quickstart",
      "destination": "/start-here/get-started"
    },
    {
      "source": "/introduction",
      "destination": "/cloud/get-started"
    },
    {
      "source": "/roadmap/roadmap",
      "destination": "/roadmap"
    },
    {
      "source": "/changelog/changelog",
      "destination": "/changelog"
    },
    {
      "source": "/cloud/share-with-your-team/team-templates",
      "destination": "/cloud/share-with-your-team/collections"
    },
    {
      "source": "/start-here/connect-your-stack/connect-slack-mcp",
      "destination": "/cloud/share-with-your-team/shared-mcp-connections#slack"
    }
  ],
  "errors": {
    "404": {
      "redirect": false,
      "title": "Missing Documentation?",
      "description": "If you're technical and want to use a specific part of the app that is not documented well yet, [send us a quick email](mailto:[email protected]?subject=missing%20documentation&body=hey%20my%20github%20is%20%7Busername%7D%2C%20I%27m%20interested%20in%20%7Bfeature%7D%20from%20omnirush%20but%20I%27m%20missing%20documentation%20on%20it%2C%20could%20you%20create%20it%3F%0A%0AThanks) and tell us what you're missing."
    }
  },
  "navbar": {
    "primary": {
      "type": "button",
      "label": "Download OmniRush.ai",
      "href": "https://github.com/omnirush-ai/omnirush-gui/releases/latest"
    }
  }
}