📑 Learn about Shortest
Shortest is an AI-powered, open-source end-to-end testing framework that simplifies test creation using natural language.
ℹ️ Explore the utility value of Shortest
To begin using Shortest, first install it as a development dependency in your project. You can choose your preferred package manager: npm, pnpm, or yarn. For example, using npm, you would run "npm install --save-dev shortest". Once installed, configure Shortest by creating a "shortest.config.ts" file in your project root. This configuration file is crucial for defining your testing environment. Within "shortest.config.ts", you must specify a "baseURL" for your application, the "testDir" where your test files will reside, and an "AnthropicAPIKey" for leveraging the AI capabilities. Ensure your Anthropic API key is securely managed, ideally through environment variables. For tests requiring GitHub authentication, Shortest supports two-factor authentication (2FA). To set this up, you'll need to obtain your OTP secret from GitHub. This secret should then be added to your environment variables, allowing Shortest to securely log in and interact with GitHub-protected resources during test execution. After configuration, you can start writing your tests in plain English within the specified test directory. Shortest's AI will interpret these natural language descriptions to automate browser interactions. The framework is built on Playwright, ensuring robust and reliable test execution. During test runs, Shortest automatically captures screenshots, storing them in a ".shortest/" directory. It is highly recommended to add this directory to your project's ".gitignore" file to prevent committing transient test artifacts. Additionally, Shortest offers lifecycle hooks for setting up and tearing down test environments, providing granular control over your test suite. Callback functions are also supported for custom assertions and advanced logic, enhancing the flexibility of your tests.
AI
Ask AI about Shortest
Get notified when this AI tool updates
Enter your email to receive update notifications.
⭐ Features of Shortest: highlights you can't miss!
Write your end-to-end tests in plain English, allowing the AI to interpret and execute them automatically.
Leverage artificial intelligence to automate complex browser interactions, streamlining test execution without manual scripting.
Securely authenticate with GitHub using two-factor authentication, enabling tests for protected resources.
Utilize lifecycle hooks to precisely set up and tear down test environments, ensuring consistent and controlled testing.
Integrate callback functions to implement custom assertions and advanced logic tailored to your specific testing needs.
Developers
To focus on application logic by simplifying test creation and maintenance with natural language testing.
QA Teams
To streamline end-to-end testing processes and reduce the complexity of test creation.
Teams using CI/CD
To run their Continuous Integration suite faster and reduce regressions through more accessible test writing.
Open-Source Contributors
As an open-source project, it invites collaboration and customization from the community.
How to get Shortest?
Visit SiteFAQs
What is Shortest?
Shortest is an open-source, AI-powered end-to-end testing framework that interprets natural language to automate browser interactions.
How does Shortest simplify testing?
It allows tests to be written in plain English, uses AI for browser automation, and integrates with GitHub, reducing the need for complex testing syntax.
What technologies does Shortest use?
Shortest is built on Playwright for robust browser automation and leverages AI, requiring an Anthropic API key for its natural language processing capabilities.
English