Get help

Report a problem, ask a question or report a security issue, and say what to include.

Check the docs first

Many messages Marfa gives have a page that explains them. Troubleshooting lists them by what you see. From a terminal, search the docs without opening a browser:

marfa docs search "version conflict"

Report a problem

Report something that doesn't work as it should as an issue on withmarfa/marfa, with the Bug report form. It asks:

  • What happened. Paste the message Marfa gave you here, word for word, such as marfa: the server refused (404 item_not_found): Item not found, with the line after it, Request ID: <id>, which finds the request in the server's log. With --json, the CLI prints the same refusal as one line of JSON, with the ID in server.request_id.
  • What you expected instead.
  • Steps that make it happen.
  • Version: of the CLI and of your instance. marfa --version gives the CLI's, and marfa status gives your instance's on its instance line, such as Marfa 0.0.80.
  • Platform: where it ran, such as macOS 27 or Linux in Docker.
  • Logs or screenshots, if you have them. This one is optional.

Leave out anything private: keys, passwords, the contents of your files and notes, and your instance's address. Read a log through before you paste it.

Ask a question or share an idea

Ask in Questions, and suggest something Marfa could do in Ideas.

Report a security issue

Never report a security issue in a public issue or discussion. Report it privately, as the security policy explains: select Report a vulnerability on the repository's Security tab, and say what you found, how to make it happen and what someone could do with it. Only the latest release gets security fixes, so check the problem is still there after you upgrade.

On this page