Skip to content
Menu

Documentation

Getting help

For a framework error, start with its code:

uv run sandloom explain SANDLOOM-C001
uv run sandloom docs db

The error catalogue explains every code and its fix. The CLI reference lists commands; each command's --help is authoritative for the installed version. Local documentation search works without an external service.

Ask or report a problem

Use the public GitHub issue tracker. GitHub Discussions is not currently the support channel. Include:

  • the installed Sandloom/Python versions and operating system;
  • the smallest application or sequence of commands that reproduces the issue;
  • expected and actual behavior, the error code and a redacted traceback;
  • the test-order seed when a failure depends on order.

Run uv run sandloom version for the framework version. Remove credentials, authentication tokens, personal data and production URLs before posting logs or configuration. A small reproduction is more useful than a production dump. There is no guaranteed support response time.

Security reports

Do not disclose a suspected vulnerability in a public issue. Use GitHub Private Vulnerability Reporting and follow the repository's security policy.

Keep learning

Start with the quickstart and the tutorial. For an existing application, use the upgrade checklist.