Quick start

From sign-up to a fix live on your site. Five steps, about ten minutes, one script tag.

  1. Create a workspace

    Sign up: verify your email, set up two-factor authentication, pick a plan. Then sign in at your workspace address, for example https://acme.sarcio.io.

  2. Add a site and copy its site key

    On the Sites tab, fill in Add a site. Copy the site key (pk_…). It is public and safe to ship to browsers.

  3. Paste the script tag

    Add this to every page, with your site key. It adds the bug reporter and applies approved front-end fixes.

    HTML

    <script  src="https://control.sarcio.io/sarcio.js"  data-sarcio-key="pk_your_site"  data-sarcio-api="https://control.sarcio.io"  defer></script>

    Reload your site. The reporter button appears bottom right. Nothing is sent until someone presses Send report.

    AttributeWhat it does
    data-sarcio-keyRequired. Your site key (pk_…).
    data-sarcio-apiRequired. Always https://control.sarcio.io.
    data-sarcio-accentBrand color as 6-digit hex, e.g. #1A73E8. Default: Sarcio emerald.
    data-sarcio-accent-darkHover and gradient shade. Default: derived from the accent.
    data-sarcio-mode"light" (default) or "dark", to match your page.
    data-sarcio-icon-pathA 24×24 SVG path ("d" string) for the launcher icon, drawn in white.

    An invalid value falls back to its default. On WordPress, skip the tag and install the plugin.

  4. Connect your Git host

    Every approved fix opens a pull request with the permanent change. An admin connects the host once, on the Integrations tab:

    Point the site at its repository

    On the Sites tab, press Manage and open Repository & source:

    FieldWhat to enter
    Forge hostYour Git host: github.com, gitlab.com or bitbucket.org.
    Repo owner, Repo nameThe repository the fix goes to.
    Default branchThe branch pull requests target. Required for a pull request.
    Source fileThe file a front-end or server-side fix edits.
    Server source fileOptional. The file server-side fixes edit, when different.
    Module entry, Module app rootOnly for code fixes.

    Paths are relative to the repository root, with no leading slash. Emptying a field clears it.

  5. Report a bug, approve the fix, see it live

    Press the reporter on your site and describe a bug. Sarcio drafts a fix. Preview it, rate its risk, approve it. It goes live for every visitor in seconds and the pull request opens. Follow Run your first fix for each screen.

Next

  • Server-side fixes: fix API and validation bugs. Needs the sidecar and the Sarcio library for your app.
  • Code fixes: replace buggy front-end code in place, state preserved. Needs a bundler plugin.
  • Jira: a ticket for every fix.

All guides

Every fix is signed by your workspace and checked before it applies. If anything is wrong, your site runs its normal code. See Security and Permissions. Stuck? support@sarcio.io

Ready to wire it up?

Create a workspace and paste one script tag.

Create a workspace