Getting help
If you canβt resolve your issue with the documentation, hereβs where to get help.
Which channel
| Channel | Use it for | Where |
|---|---|---|
| Discord | Setup and configuration questions β usually the fastest route | ci.computer/ggΒ |
| Support page | A question you want the team to answer directly | ci.computer/supportΒ |
| Companion Hub issues | Reproducible bugs and feature requests in Hub, the CLI, and the desktop app. Attach a screenshot when the problem is visible | github.com/companionintelligence/Companion-Hub/issuesΒ |
| CI-Marketplace issues | Problems with an app catalog entry | github.com/companionintelligence/CI-Marketplace/issuesΒ |
| CI-Docs issues | Anything wrong or missing on this site | github.com/companionintelligence/CI-Docs/issuesΒ |
| Pull request | You already know the fix | Running locally |
The Companion Hub repository is public, so its issues page loads for anyone and you need only a GitHub account to open an issue. The CI-Marketplace and CI-Docs repositories are private: their links return a 404 unless your GitHub account has been granted access. Discord and the support page work for everyone.
flowchart LR
q["Need help?"] --> r{"Reproducible bug or<br/>feature request?"}
r -->|"No: a setup or<br/>configuration question"| d["Discord or<br/>the support page"]
r -->|"Yes"| w{"Which part?"}
w -->|"Hub, CLI, desktop app"| h["Companion Hub issues"]
w -->|"An app catalog entry"| m["CI-Marketplace issues"]
w -->|"This site"| o["CI-Docs issues"]
r -->|"You know the fix"| c["Run Hub locally,<br/>open a pull request"]
click d "https://ci.computer/gg"
click h "https://github.com/companionintelligence/Companion-Hub/issues"
click m "https://github.com/companionintelligence/CI-Marketplace/issues"
click o "https://github.com/companionintelligence/CI-Docs/issues"
click c "/docs/contributing/running-locally"Before you ask
Having these ready makes it much faster for anyone to help you:
cihub doctorcihub statuscihub versioncihub app logs <container-name>Include your OS, whether youβre running the desktop app or headless, and the output of cihub doctor and cihub status. From Settings β Logs, Download full logs saves the Hubβs log as ci-hub-logs.log. Donβt post pairing codes, API keys, or the contents of your env file. Since 0.3.0, Hub replaces known secrets in its own log with [REDACTED], but a log from an earlier release can hold some, so read a log before you post it.
Community
Join the Discord to get help from other Companion Hub users and the development team β usually the fastest route for setup and configuration questions.
GitHub issues
For reproducible bugs and feature requests, open an issue:
- Companion Hub issuesΒ β Hub, CLI, and desktop app
- Marketplace issuesΒ β app catalog entries
- Docs issuesΒ β anything wrong or missing on this site
Contributing
If you know how to fix a bug, start with Running locally to contribute the change.