# BugBug Documentation ## BugBug Documentation - [Documentation](https://docs.bugbug.io/master.md): Step into the BugBug documentation section, where you'll find complete resources on how to use our tool and how to start with test automation for your website. - [Best practices](https://docs.bugbug.io/best-practices.md) - [BugBug App FAQ](https://docs.bugbug.io/bugbug-app-faq.md) - [Setup BugBug](https://docs.bugbug.io/quick-start/setup-bugbug.md): Start your test automation for free with BugBug. Sign up for a free plan with unlimited local test runs and try our advanced features for 14 days. - [Install Test Recorder](https://docs.bugbug.io/quick-start/install-test-recorder.md): Run and record your tests with BugBug Chrome Extension in incognito mode. See how easy is the process of setting up BugBug for your test automation. - [Your first automated flow](https://docs.bugbug.io/quick-start/your-first-automated-flow.md) - [Create your project](https://docs.bugbug.io/quick-start/your-first-test.md): You have logged in to BugBug and let's take a ride! Create your first project to organize your automated tests and suites. - [Your first test](https://docs.bugbug.io/creating-tests/recording-the-tests.md): Learn the basics of creating your first automated test with BugBug. The process is very simple and doesn't require any coding knowledge. See how easy it is to run your first test. - [Independent tests](https://docs.bugbug.io/creating-tests/independent-tests.md): Learn why independent tests are crucial for end-to-end testing process. A good practice in automation testing is that every test is completely independent of other tests. - [Duplicating tests](https://docs.bugbug.io/creating-tests/duplicating-tests.md): See how to duplicate your tests with BugBug without a need to create them from scratch. - [New test from here](https://docs.bugbug.io/creating-tests/new-test-from-here.md): See how to avoid recording the same test steps multiple times. With BugBug you can duplicate them so that only part of the steps is copied over. - [BugBug AI test recorder](https://docs.bugbug.io/recording-tests-steps/bugbug-ai-test-recorder.md): Learn how BugBug overlay works while recording your test. Record all clicks, catch selecting form elements, navigate to URLs and record typing in the text fields. - [Recording clicks](https://docs.bugbug.io/recording-tests-steps/recording-clicks.md): See how recording clicks work. By default, when you record a test, BugBug records all your clicks. You don't need to activate any recording mode. - [Recording hover](https://docs.bugbug.io/recording-tests-steps/recording-hover.md): BugBug won't record hover events automatically. There is no reliable way of automatically detecting that something changed on the page because of cursor movement. - [Recording keyboard typing](https://docs.bugbug.io/recording-tests-steps/recording-keyboard-typing.md): See how to record keyboard typing with BugBug. During the recording, BugBug will automatically record everything you type in the text fields. You don't need to activate anything. - [Recording assertions](https://docs.bugbug.io/recording-tests-steps/recording-assertions.md): Learn what an assertion is and how to use it during recording your test with BugBug. Use assertions to check if your page behaves as it should, without interacting with it. - [Recording drag & drop](https://docs.bugbug.io/recording-tests-steps/recording-drag-and-drop.md) - [Record from here](https://docs.bugbug.io/recording-tests-steps/record-from-here.md): Read about Record from here feature. BugBug allows you to start recording from any step in your test. No need to record from scratch every time. - [Re-recording steps](https://docs.bugbug.io/recording-tests-steps/re-recording-steps.md): See how easy it is to re-record test steps with BugBug. If your test failed and you need to fix it, it's way faster to record the steps "from here" rather than edit them manually. - [Recording pop-up window actions](https://docs.bugbug.io/recording-tests-steps/recording-pop-up-window-actions.md) - [Using keyboard shortcuts](https://docs.bugbug.io/recording-tests-steps/using-keyboard-shortcuts.md) - [AI test recorder FAQ](https://docs.bugbug.io/recording-tests-steps/ai-test-recorder-faq.md) - [How BugBug AI works](https://docs.bugbug.io/recording-tests-steps/how-bugbug-ai-works.md) - [Grouping steps](https://docs.bugbug.io/editing-tests/grouping-steps.md): Learn how to group your test steps. BugBug supports "step groups" to make sure you can easily navigate in large projects. Very useful feature if you work on a large amount of test cases. - [Components](https://docs.bugbug.io/editing-tests/components.md): Learn about BugBug Components that can save a lot of your time when you want to work with test automation for complex products. BugBug always make the test automation process ultra-simple. - [Manually editing steps](https://docs.bugbug.io/editing-tests/manually-creating-the-test.md): BugBug allows users to manually edit test steps. Although this is not a recommended way of updating tests. It's often much faster to fix the tests by removing the failed steps and recording them again - [Actions](https://docs.bugbug.io/editing-tests/actions.md): Learn about Actions that you can choose while adding test steps manually. BugBug provides mouse actions, input actions, window actions and some advanced actions like running custom JavaScript. - [Assertions](https://docs.bugbug.io/editing-tests/assertions.md): Enhance your software testing with BugBug's Tests Assertions. Discover how to create powerful assertions to validate your test behavior. Streamline your debugging process. - [Tabs & iframes](https://docs.bugbug.io/editing-tests/tabs-and-iframes.md): Enhance your test editing skills with BugBug's comprehensive guide on Tabs and iframes. Learn how to effectively optimize your test scenarios. Discover valuable tips to streamline your testing process - [Conditional Logic (if/else)](https://docs.bugbug.io/editing-tests/conditional-logic-if-else.md) - [Variables](https://docs.bugbug.io/editing-tests/variables.md) - [Local variables](https://docs.bugbug.io/editing-tests/local-variables.md) - [Custom JavaScript actions](https://docs.bugbug.io/editing-tests/custom-javascript-actions.md) - [Running the tests](https://docs.bugbug.io/running-tests/running-tests.md): Discover how to efficiently run tests with BugBug. Learn the best practices and techniques to optimize your testing process. Improve your software quality today - [Statuses](https://docs.bugbug.io/running-tests/statuses.md): Learn about BugBug's test status functionalities and improve your testing process. Explore different test statuses for effective test management. - [Run (locally)](https://docs.bugbug.io/running-tests/test-in-your-browser.md): Discover how to run tests in your browser with BugBug's comprehensive guide. Streamline your testing process for efficient software development. Learn more now! - [Run and pause here](https://docs.bugbug.io/running-tests/run-and-pause-here.md) - [Run in cloud](https://docs.bugbug.io/running-tests/in-cloud-on-server.md): Discover how to run tests in the cloud or on your server with BugBug's comprehensive guide. Improve your testing efficiency and scalability today. - [Schedules](https://docs.bugbug.io/running-tests/schedules.md): Discover BugBug's comprehensive guide on how to use test schedules. Learn efficient techniques to optimize your testing process and enhance software quality. - [Parallel runs](https://docs.bugbug.io/running-tests/parallel-mode.md): Discover the power of parallel mode in test execution with BugBug. Boost productivity and efficiency with simultaneous test runs. Get started for free now! - [Running via API](https://docs.bugbug.io/running-tests/running-via-api.md): Discover how to run tests via API with BugBug's comprehensive documentation. Connect BugBug to your CI/CD pipeline. Streamline your automation testing process. - [Test your local build or protected web page using ngrok](https://docs.bugbug.io/running-tests/test-your-local-build-or-protected-web-page-using-ngrok.md): Learn how to test your local build or protected web page using ngrok. BugBug provides step-by-step instructions and tips for seamless testing. Start testing for free! - [How it works?](https://docs.bugbug.io/visual-regression/how-it-works.md) - [Best practices](https://docs.bugbug.io/visual-regression/best-practices.md) - [Review & fix](https://docs.bugbug.io/visual-regression/review-and-fix.md) - [Waiting conditions](https://docs.bugbug.io/preventing-failed-tests/waiting-conditions.md): Learn effective waiting conditions to prevent failed tests. Improve your test automation process with BugBug's expert guidance. Start your test automation today. - [Smart click](https://docs.bugbug.io/preventing-failed-tests/smart-click.md): Discover BugBug's smart click feature to prevent failed tests efficiently. Improve your testing process and enhance software quality with ease. - [Smart scroll](https://docs.bugbug.io/preventing-failed-tests/smart-scroll.md): Discover how to prevent failed tests with smart scroll. Improve your test efficiency and reliability using BugBug's smart scroll feature. Learn more now! - [Selectors](https://docs.bugbug.io/preventing-failed-tests/selectors.md): Learn how to prevent failed tests with efficient selectors. BugBug's comprehensive guide provides valuable insights and best practices. Start optimizing your testing process today! - [Timeout](https://docs.bugbug.io/preventing-failed-tests/timeout.md): Discover effective strategies to prevent failed tests due to timeouts. Learn how to optimize your test environments and code execution for smooth test runs. - [Delay / Sleep](https://docs.bugbug.io/preventing-failed-tests/delay-sleep.md): Learn how to prevent failed tests and improve test reliability with delay and sleep techniques. Explore BugBug's comprehensive guide for efficient test execution. - [Project settings](https://docs.bugbug.io/preventing-failed-tests/project-settings.md): Learn about BugBug's project settings. BugBug's comprehensive guide provides effective strategies and solutions. Start testing for free now! - [Runs history](https://docs.bugbug.io/debugging-tests/runs-history.md): Explore BugBug's Runs History for efficient test debugging. Access logs, track progress, and review your past tests and suites runs. Try it now! - [Screenshots](https://docs.bugbug.io/debugging-tests/screenshots.md): Discover BugBug's powerful debugging tests screenshots feature. Streamline bug identification and resolution with clear visual evidence. Try it now! - [DOM Snapshot](https://docs.bugbug.io/debugging-tests/dom-snapshot.md) - [Console logs](https://docs.bugbug.io/debugging-tests/console-logs.md) - [Network logs](https://docs.bugbug.io/debugging-tests/network-logs.md) - [Debug in Chrome](https://docs.bugbug.io/debugging-tests/debug-in-chrome.md): Discover effective debugging techniques in Chrome with BugBug. Streamline your test debugging process and solve issues efficiently. Try it for free now! - [Breakpoint (run step-by-step)](https://docs.bugbug.io/debugging-tests/breakpoint-run-step-by-step.md): Master the art of debugging tests with BugBug's comprehensive guide on using breakpoints. Enhance your troubleshooting skills and boost software quality. - [Error codes](https://docs.bugbug.io/debugging-tests/error-codes.md) - [Naming your tests](https://docs.bugbug.io/organizing-tests/organising-your-tests.md): Learn how you can structure your tests to make it clean and useful! Learn effective test organization techniques to streamline your testing process with BugBug's comprehensive guide. - [Searching tests](https://docs.bugbug.io/organizing-tests/searching-tests.md): Learn how to efficiently search and organize your tests using BugBug's comprehensive documentation. Boost your testing productivity today! - [Suites](https://docs.bugbug.io/organizing-tests/suites.md): Explore BugBug's comprehensive guide on organizing test suites efficiently. Learn how to gorup test cases to run them in parallel. Start testing for free! - [Projects](https://docs.bugbug.io/organizing-tests/projects.md): Discover BugBug's guide on organizing tests within projects. Learn effective strategies for seamless test automation management and maximize your testing efficiency. Start now! - [Reporting](https://docs.bugbug.io/organizing-tests/reporting.md) - [Standard reports](https://docs.bugbug.io/organizing-tests/reporting/standard-reports.md) - [Advanced reports](https://docs.bugbug.io/organizing-tests/reporting/advanced-reports.md) - [Edit & Rewind](https://docs.bugbug.io/workflow-tips/edit-and-rewind.md) - [Changing the test screen size](https://docs.bugbug.io/workflow-tips/changing-the-test-screen-size.md): Discover BugBug tips on changing the test screen size in your testing workflow. Optimize your automation testing process for better results. Read now! - [Integrating with build systems](https://docs.bugbug.io/workflow-tips/integrating-with-build-systems.md): Learn about integrating BugBug with your build systems for seamless test management. Integrate with your CI/CD pipelines, GitHub, GitLab, Bitbucket, Bamboo, Jenkis and many more. - [Mobile version testing](https://docs.bugbug.io/workflow-tips/mobile-version-testing.md): Enhance your mobile version testing workflow with BugBug's tips. Optimize your website's performance and user experience on mobile devices. - [Organizations](https://docs.bugbug.io/collaboration/organization-settings.md): Discover BugBug's collaboration and organization settings. You can modify, add or delete information regarding your organization. Optimize teamwork and enhance your productivity. - [Inviting team members](https://docs.bugbug.io/collaboration/inviting-team-members.md): Learn how to invite team members and enhance your team collaboration with BugBug. You can work together on test cases, share links to test results, empower developers and many more. - [Project access management](https://docs.bugbug.io/collaboration/project-access-management.md) - [Alerts](https://docs.bugbug.io/collaboration/alerts.md): Stay connected and informed with BugBug's collaboration notifications feature. Streamline teamwork and never miss your test results. Try it now for free! - [Sending email notification](https://docs.bugbug.io/collaboration/alerts/sending-email-notification.md) - [Sending webhook](https://docs.bugbug.io/collaboration/alerts/sending-webhook.md) - [Sending Slack message](https://docs.bugbug.io/collaboration/alerts/sending-slack-message.md) - [CLI](https://docs.bugbug.io/integrations/api.md): Integrate BugBug with any continuous integration (CI) or continuous deployment (CD) pipelines or build system hooks. - [Zapier](https://docs.bugbug.io/integrations/zapier.md): Discover seamless integration between BugBug and Zapier for efficient test automation. Streamline processes and boost QA productivity effortlessly. - [Slack](https://docs.bugbug.io/integrations/slack.md): Discover seamless integration between BugBug and Slack for efficient bug tracking and collaboration. Streamline your workflow with ease. Learn more! - [GitHub](https://docs.bugbug.io/integrations/github.md): Streamline your GitHub workflow with BugBug's seamless integration. Collaborate efficiently and track issues effortlessly. Try it now for free! - [Bitbucket](https://docs.bugbug.io/integrations/bitbucket.md): Discover seamless integration between BugBug and Bitbucket for efficient bug tracking. Streamline your test automation process today! - [Gitlab](https://docs.bugbug.io/integrations/gitlab.md): Discover seamless GitLab integration with BugBug. Run your test automation from GitLab CI/CD pipelines using our CLI. - [Trello](https://docs.bugbug.io/integrations/trello.md): Seamlessly integrate Trello with BugBug to enhance collaboration and create Trello tasks when the scheduled tests failed. Explore our integration guide! - [Jira](https://docs.bugbug.io/integrations/jira.md): Discover seamless integration between BugBug and Jira for efficient bug tracking and project management. Jira integration allows you to integrate BugBug runs with your development process. - [Webhooks](https://docs.bugbug.io/integrations/webhooks.md): Incoming webhooks let you start test and suite runs by sending a simple POST request. - [Discord](https://docs.bugbug.io/integrations/discord.md) - [Linear](https://docs.bugbug.io/integrations/linear.md) - [Public API](https://docs.bugbug.io/integrations/public-api.md) - [Config](https://docs.bugbug.io/public-api-reference/config.md) - [Tests](https://docs.bugbug.io/public-api-reference/tests.md) - [Suites](https://docs.bugbug.io/public-api-reference/suites.md) - [Test Runs](https://docs.bugbug.io/public-api-reference/test-runs.md) - [Suite Runs](https://docs.bugbug.io/public-api-reference/suite-runs.md) - [Profiles](https://docs.bugbug.io/public-api-reference/profiles.md) - [Groups](https://docs.bugbug.io/public-api-reference/groups.md) - [Steps](https://docs.bugbug.io/public-api-reference/steps.md) - [Components](https://docs.bugbug.io/public-api-reference/components.md) - [Settings](https://docs.bugbug.io/public-api-reference/settings.md) - [Visual Regression](https://docs.bugbug.io/public-api-reference/visual-regression.md) - [Models](https://docs.bugbug.io/public-api-reference/models.md) - [Account settings](https://docs.bugbug.io/your-account/account-settings.md): Optimize your BugBug account settings for better performance and personalized experiences. Explore our comprehensive guide to fine-tune your preferences. - [Edit your name and email](https://docs.bugbug.io/your-account/edit-your-name-and-email.md): Effortlessly update your account details in BugBug app. Edit your name and email hassle-free to keep your profile information up to date. - [Forgot password](https://docs.bugbug.io/your-account/forgot-password.md): Reset your BugBug account password hassle-free. Follow the simple steps provided in our guide. - [Manage Subscriptions](https://docs.bugbug.io/your-account/subscriptions-bugbug-versions.md): Manage your BugBug subscriptions and stay up to date with the latest BugBug versions. - [Account FAQ](https://docs.bugbug.io/your-account/account-faq.md): Discover answers to frequently asked questions about BugBug accounts. Learn how to manage your account settings and use BugBug for test automation. - [Prohibited behaviors](https://docs.bugbug.io/troubleshooting/prohibited-behaviors.md): Discover common prohibited behaviors and effective troubleshooting techniques of BugBug app. Get insights to overcome some certain limitations. - [Updating Chrome extension](https://docs.bugbug.io/troubleshooting/updating-chrome-extension.md): Find solutions and troubleshooting tips for updating your BugBug Chrome extension. Get step-by-step guidance and fix compatibility issues. - [Clear cookies and site data for BugBug](https://docs.bugbug.io/troubleshooting/clear-cookies-and-site-data-for-bugbug.md): Learn how to troubleshoot and clear cookies and site data for BugBug. Watch our video now - [Testing basic auth password protected websites](https://docs.bugbug.io/troubleshooting/testing-basic-auth-password-protected-websites.md): Learn how to troubleshoot and test basic auth password-protected websites with BugBug's comprehensive guide. - [Common selectors issues](https://docs.bugbug.io/troubleshooting/common-selectors-issues.md) - [CAPTCHA in automation testing](https://docs.bugbug.io/troubleshooting/captcha-in-automation-testing.md): Discover effective troubleshooting tips for resolving captcha challenges in automation testing. Learn how to overcome obstacles and improve your testing process. BugBug Documentation. - [Cloud tests sometimes failing](https://docs.bugbug.io/troubleshooting/cloud-tests-sometimes-failing.md): Discover effective troubleshooting techniques for resolving intermittent cloud test failures. BugBug's comprehensive guide helps you tackle testing challenges. - [IPs list of cloud runners](https://docs.bugbug.io/troubleshooting/ips-list-of-cloud-runners.md) - [VPN or a Firewall](https://docs.bugbug.io/troubleshooting/vpn-or-a-firewall.md): Resolve VPN or Firewall issues with BugBug's comprehensive troubleshooting guide. Get expert tips and solutions for seamless network connectivity. - [A/B tests](https://docs.bugbug.io/troubleshooting/a-b-tests.md) - [Report a bug](https://docs.bugbug.io/troubleshooting/report-a-bug.md): Need to report a bug? Our comprehensive troubleshooting guide helps you navigate the process smoothly. - [Beginners tutorial to automation testing](https://docs.bugbug.io/in-depth-guides/beginners-tutorial-to-automation-testing.md): Learn the basics of automation testing with our comprehensive beginner's tutorial. Boost your test automation skills with BugBug's in-depth guide. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.bugbug.io/master.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.