HOS AIHOS AI

Draft

Get help

What to check first, what to send, and where to ask.

On this page

In short

Questions and problems with the tools go to the project's GitHub issues, where anyone can answer and everyone can find the answer later. Check five things first, then send what someone needs to reproduce your problem, with made-up data only.

Before you ask

  1. Paste the message into the search box at the top of these pages. Troubleshooting has an entry for every message of hos.
  2. Check your versions: node --version prints 22 or more, and npx @hos-ai/cli@latest --version gives the newest version of hos, which may already fix your problem.
  3. Run the command again, alone, in a new terminal, in the folder of your files. Many problems come from a folder or a shell.
  4. Read the rule that an error names: Rules explains each one, with how to fix it.
  5. Try the example of the guide you follow. If the example works and your file does not, the difference is the answer, or a good question.

Ask on GitHub

Open an issue with the template for the CLI and the SDK. It asks for what someone needs to reproduce your problem:

  • the output of hos --version, or the version of @hos-ai/sdk in your package.json;
  • the output of node --version, and your system, such as Windows 11 with PowerShell;
  • the exact command you ran, or a short piece of code;
  • everything it printed, with --json when the command has it;
  • a file that shows the problem, if there is one.

A question about the documentation itself, such as a step that does not work or a sentence that is unclear, goes in an issue too: each page has a "Report a problem with this page" link at its foot, which fills in the page for you.

Made-up data only

The repository is public, and so is every issue. Never send real guest data, a hotel's operational data, credentials, API keys or a private key. Replace names and ids with made-up ones, as the examples of these pages do. If the problem only shows with real data, say so, and describe it without the data.

Report a vulnerability

A security problem, such as a way to get a signature accepted that should not be, does not go in a public issue. Follow the security policy, which says how to report it privately.

What to expect

The tools are alphas, maintained in the open. Issues are read and answered as time allows; there is no support contract and no response time. Fixes come in new versions of the packages, which their changelogs list: the command, the SDK.