Exporting

Download your BugBug tests and projects as YAML, from the app or through the Public API, and keep them in version control.

Export a single test

1. Open the test.

2. Open the Actions menu in the top right.

3. Choose Export.

4. Pick a format and confirm.

The export modal offers two formats:

Format	Contains
YAML	The test alone. Components and any files it uses are referenced, not included.
ZIP with components	The test, every reusable component it uses, and the files those steps need.

Choose YAML when the destination project already has the required components or when you want a file that is easy to review. Choose ZIP when the destination may not have those components or files.

---

Export a whole project

A project export is always a ZIP. It contains the tests, components, suites, profiles, project settings, folder structure, and uploaded files.

You can start it from two places:

• Project settings → Export → Download .zip

• The Actions menu on a project card in your project list → Export

---

Export with the CLI

You can export a project ZIP or an individual test as YAML or ZIP from the terminal. See the BugBug CLI for commands and authentication options.

Use bugbug project export for a project ZIP. Use bugbug tests export <test-id> --format yaml or --format zip for one test.

---

Export through the API

The Public API returns both exports from GET endpoints. Authenticate with your project API token:

Export a test as YAML

curl -L \
  -H "Authorization: Token <api-token>" \
  "https://api.bugbug.io/v2/tests/<test-id>/export/yaml/" \
  -o test.bugbug.yaml

Replace yaml with zip to include the test's components. To export the whole project, call /v2/project/export/. The API token identifies the project, so that endpoint needs no project ID.

View export endpoint

---

File names

Downloads use the slug of the exported item:

Export	File name
Test as YAML	test_<slug>.bugbug.yaml
Test as ZIP	test_<slug>.zip
Project as ZIP	project_<slug>.zip

---

What an export does not include

An export contains definitions, not run results. It does not include:

• run history

• screenshots and DOM snapshots captured during runs

• console and network logs

Visual regression baselines are included because they are part of the test definition. A ZIP export puts them in artifacts/, alongside files used by upload steps.

Use a project export to move or preserve the test suite. It does not archive the results of previous runs.

---

Keeping exports in Git

Exports are plain text files, so Git can show changes to steps and selectors. Commit an export, change a test in BugBug, and export it again to see the difference:

   - action: click
     action_details:
-      selector: xpath=//BUTTON[@id="submit"]
+      selector: xpath=//BUTTON[@data-testid="submit"]

You can review those changes in the same pull request as the product changes that prompted them.

Exports contain secret values in plain text.

Exports do not mask secrets. Profile variables marked as secret are written with their real values. The same applies to values entered by type steps, including passwords, and to the username and password used by basic authentication steps.

Review an export for credentials before committing it to a shared repository. Treat it like a .env file: keep it in a private repository and do not publish it.

---

Frequently asked questions

Can I export just one component, suite, or profile?

No. Export the project to get all of them, or export a test as ZIP to get the components it uses.

Can I export from the CLI?

Yes. The CLI can export project ZIP files and individual tests as YAML or ZIP. See Export with the CLI.

Does exporting change anything in my project?

No. Export is read-only.

Can I export several tests at once without exporting the whole project?

Not from the app. Export the project ZIP and take the files you need out of tests/.