Spec0docsCLI 0.7.0

Support

Where to report a bug, ask a question, or get help — and what to include so it can be answered.

Something broken, confusing, or missing? Here is where each kind of problem goes.

Report a problem in Spec0

If you are signed in, use the Feedback button in the sidebar of the dashboard. It is the fastest route, because the page you were on and your account travel with the report — you do not have to describe where you were or who you are.

If you are not signed in, use the contact form. Leave an email address and a reply comes back to you.

Both reach the same place, and a person reads them.

Report a problem in the open-source tools

The CLI, the mock server, Studio and the publish action are open source, and an issue on the relevant repository is public, searchable, and usually the faster route — somebody else may have hit the same thing.

Not sure which?

Report it wherever you were when it happened. A misfiled report still gets read; a report nobody sent because they could not decide does not.

What to include

You do not need a formal bug report. One sentence about what happened is enough to start. If you have them to hand, these are the things that most often decide whether a problem can be reproduced:

  • What you expected, and what happened instead. The gap between the two is usually the bug.
  • The API or organisation involved, if it is specific to one.
  • The exact command, for CLI problems — including the flags.
  • Whether it is repeatable. "Every time" and "once, yesterday" lead to completely different investigations.

Do not send us credentials. A token, password or API key is never needed to investigate a report, and an issue is a public place. If you believe a credential has leaked, say so without pasting it.

Something is down

Check status.spec0.io first — it runs live checks against the API, the dashboard, and the docs, so it will tell you whether the problem is ours and already known.

Security

If you have found a vulnerability, please do not open a public issue. Email hello@spec0.io with the details and we will reply. We would rather hear about it privately and fix it than read about it at the same time as everybody else.

Was this helpful?

On this page