# Jetify > Documentation for Jetify ## Pages - [Jetify Documentation](jetify-documentation.md) - [Authenticating with the Cache](authenticating-with-the-cache.md): Your Jetify Cloud organization is automatically provisioned with a shared cache. Any developers invited to your Jetif... - [Caching and Sharing Packages with Jetify](caching-and-sharing-packages-with-jetify.md): The provides teams with a private, secure Nix package cache that makes it easy to share packages across all your pro... - [Using the Jetify Prebuilt Cache](using-the-jetify-prebuilt-cache.md): The Jetify Prebuilt Cache provides users with prebuilt binaries of popular packages for the most common OS(Linux, mac... - [Pushing and Pulling Packages to the Cache](pushing-and-pulling-packages-to-the-cache.md): Once you have authenticated, Devbox will automatically configure your cache for you. You can also - [Cache an installable hosted on Github (process-compose)devbox cache upload github:F1bonnac1/process-compose# Cache a package from nixpkgsdevbox cache upload nixpkgs#mongodb](cache-an-installable-hosted-on-github-process-composedevbox-cache-upload-githubf.md) - [Creating Your Team](creating-your-team.md): Developers who want to use Jetify for their personal projects can sign up for a free account. The free account comes ... - [Introduction](introduction.md): The lets you manage your team, projects, and secrets from a single interface. You can use the Dashboard to manage yo... - [Inviting your Team Members](inviting-your-team-members.md): If you have a paid Team project, you can invite team members to join your project. Team members can configure and use... - [Setting a Custom Domain for your Project](setting-a-custom-domain-for-your-project.md): Jetify Cloud will automatically configure a unique, private domain for previewing your deployed application. For prod... - [Introduction](introduction-2.md): Jetify Deployments is an easy, Devbox friendly way to deploy a stateless application to the cloud in a few minutes. J... - [Integration Guides](integration-guides.md): This section contains guides on how to integrate common services with your Jetify deployments. - [Monitoring Your Deployments](monitoring-your-deployments.md): Jetify Cloud automatically provides build and runtime logs for each of your deployments in the Jetify Dashboard. - [Using Jetify Secrets with your Deployment](using-jetify-secrets-with-your-deployment.md): Projects deployed with Jetify Cloud are automatically configured to use when deploying your project. You do not need... - [Setting Up Your Deployment](setting-up-your-deployment.md): Deploying a project with Jetify Cloud requires the following: - [Frequently Asked Questions](frequently-asked-questions.md): This doc contains answers to frequently asked questions about Jetify Cloud that are not covered elsewhere in our docu... - [Cloud Documentation](cloud-documentation.md): Jetify Cloud gives your team the tools and frameworks to accelerate your development workflow. Jetify Cloud is built ... - [Managing Secrets from the Dashboard](managing-secrets-from-the-dashboard.md): You can add or manage secrets for a Jetify Cloud project using the Secrets tab of the Jetify Dashboard. Secrets that ... - [Introduction](introduction-3.md): Jetify Secrets is a secure secrets management service that lets you store and access secrets for your projects. Secre... - [Managing Secrets with the Devbox CLI](managing-secrets-with-the-devbox-cli.md): You can access your Jetify Secrets locally using Devbox. When you authenticate your Devbox CLI with Jetify Cloud, Dev... - [devbox add](devbox-add.md): Add a new package to your devbox - [Add the latest version of the `ripgrep` package](add-the-latest-version-of-the-ripgrep-package.md): devbox add ripgrep - [Install glibcLocales only on x86_64-linux and aarch64-linux](install-glibclocales-only-on-x86-64-linux-and-aarch64-linux.md): devbox add glibcLocales --platform x86_64-linux,aarch64-linux - [Exclude busybox from installation on macOS](exclude-busybox-from-installation-on-macos.md): devbox add busybox --exclude-platform aarch64-darwin,x86_64-darwin - [Install non-default outputs for a package, such as the promtool CLI](install-non-default-outputs-for-a-package-such-as-the-promtool-cli.md): devbox add prometheus --outputs=out,cli - [devbox cache configure](devbox-cache-configure.md): Configure Nix to use the Devbox cache as a substituter. - [devbox cache info](devbox-cache-info.md): Output information about the nix cache - [devbox cache upload](devbox-cache-upload.md): Upload specified nix installable or nix packages in current project to cache. If [installable] is provided, only that... - [devbox cache](devbox-cache.md): A collection of commands to interact with the Jetify Cache or other Nix caches. - [devbox completion bash](devbox-completion-bash.md): Generate the autocompletion script for the bash shell. - [devbox completion fish](devbox-completion-fish.md): Generate the autocompletion script for the fish shell. - [devbox completion zsh](devbox-completion-zsh.md): Generate the autocompletion script for the zsh shell. - [devbox completion](devbox-completion.md): Generate the autocompletion script for the specified shell - [devbox create](devbox-create.md): Initialize a directory as a devbox project using a template - [devbox generate devcontainer](devbox-generate-devcontainer.md): Generate Dockerfile and devcontainer.json files under .devcontainer/ directory - [devbox generate direnv](devbox-generate-direnv.md): Top level command for generating the .envrc file for your Devbox Project. This can be used with to automatically sta... - [devbox generate dockerfile](devbox-generate-dockerfile.md): Generate a Dockerfile that replicates devbox shell - [devbox generate readme](devbox-generate-readme.md): Generate a markdown readme file for this project. You must specify a name for the Readme file when running the command: - [devbox generate](devbox-generate.md): Top level command for generating Devcontainers, Dockerfiles, and other useful files for your Devbox Project. - [devbox global add](devbox-global-add.md): Add a new global package. - [Add the latest version of the `ripgrep` package](add-the-latest-version-of-the-ripgrep-package-2.md): devbox global add ripgrep - [Install glibcLocales only on x86_64-linux and aarch64-linux](install-glibclocales-only-on-x86-64-linux-and-aarch64-linux-2.md): devbox global add glibcLocales --platform x86_64-linux,aarch64-linux - [Exclude busybox from installation on macOS](exclude-busybox-from-installation-on-macos-2.md): devbox global add busybox --exclude-platform aarch64-darwin,x86_64-darwin - [devbox global install](devbox-global-install.md): Install all packages mentioned in your global devbox.json. - [devbox global list](devbox-global-list.md): Lists all the packages you have installed globally - [devbox global pull](devbox-global-pull.md): Pulls a global config from a file or URL. URLs must be prefixed with ' or ' - [devbox global push](devbox-global-push.md): Push a [global] config. Leave empty to use Jetify sync. Can be a git repo for self storage. - [devbox global rm](devbox-global-rm.md): Removes a package from your global config - [devbox global run](devbox-global-run.md): Starts a new shell and runs your script or command in it, exiting when done. - [devbox global services](devbox-global-services.md): Interact with Devbox services for your global packages. This command replicates the subcommands for but for your glo... - [devbox global shellenv](devbox-global-shellenv.md): Print shell commands that add global Devbox packages to your PATH - [devbox global update](devbox-global-update.md): Updates packages in your Devbox global config to the latest available version. - [devbox global](devbox-global.md): Top level command for managing global packages. - [devbox info](devbox-info.md): Display information for a package, including any installed plugins - [devbox init](devbox-init.md): Initialize a directory as a devbox project - [devbox install](devbox-install.md): Starts a new devbox shell and installs all packages mentioned in devbox.json in current directory or a directory spec... - [devbox rm](devbox-rm.md): Remove a package from your devbox - [devbox run](devbox-run.md): Starts a new interactive shell and runs your target script in it. The shell will exit once your target script is comp... - [Run a command directly:](run-a-command-directly.md): devbox add cowsay - [Run a command that takes flags:](run-a-command-that-takes-flags.md): devbox run cowsay -d hello - [All `devbox run` flags must be passed before the command](all-devbox-run-flags-must-be-passed-before-the-command.md): devbox run -q cowsay -d hello - [Run a script (defined as `"moo": "cowsay moo"`) in your devbox.json:](run-a-script-defined-as-moo-cowsay-moo-in-your-devboxjson.md): devbox run moo - [devbox search](devbox-search.md): Search for Nix packages - [To add ripgrep 12.1.1 to your project:](to-add-ripgrep-1211-to-your-project.md): $ devbox add [email protected] - [devbox secrets download](devbox-secrets-download.md): Download environment variables into the specified file - [devbox secrets init](devbox-secrets-init.md): Initialize devbox secrets in the project directory. This setup step creates/connects to an existing jetify cloud project - [devbox secrets list](devbox-secrets-list.md): List all stored environment variables - [devbox secrets rm](devbox-secrets-rm.md): Delete one or more environment variables - [devbox secrets set](devbox-secrets-set.md): Securely store one or more environment variables - [devbox secrets upload](devbox-secrets-upload.md): Upload variables defined in a .env file - [devbox secrets](devbox-secrets.md): Manage environment variables and secrets - [devbox services attach](devbox-services-attach.md): Attach to a running instance of . This command lets you launch the TUI for process-compose if you started your servic... - [devbox services ls](devbox-services-ls.md): List available services - [devbox services restart](devbox-services-restart.md): Restarts service. If no service is specified, restarts all services and process-compose. - [devbox services start](devbox-services-start.md): Starts a service or list of services. If no service is specified, starts all services + process-compose. - [devbox services stop](devbox-services-stop.md): Stops a service. If no service is specified, stops all your running services and shuts down process-compose. - [devbox services up](devbox-services-up.md): Starts process-compose and runs all the services in your project. If a list of services is specified in the arguments... - [Start all services with process compose in the foreground](start-all-services-with-process-compose-in-the-foreground.md): devbox services up - [Start all services with process compose in the background](start-all-services-with-process-compose-in-the-background.md): devbox services up -b - [Start only the web service with process compose in the foreground](start-only-the-web-service-with-process-compose-in-the-foreground.md): devbox services up web - [devbox services](devbox-services.md): Interact with Devbox services via process-compose - [devbox shell](devbox-shell.md): Start a new shell or run a command with access to your packages - [devbox shellenv](devbox-shellenv.md): Print shell commands that add Devbox packages to your PATH - [devbox update](devbox-update.md): Updates packages within your project to the latest available version. - [devbox version update](devbox-version-update.md): Check for a new version of devbox and update if available - [devbox version](devbox-version.md): Print version information - [devbox](devbox.md): Instant, easy, predictable shells and containers - [devbox.json Reference](devboxjson-reference.md): Your devbox configuration is stored in a file, located in your project's root directory. This file can be edited dir... - [Using Devbox in CI/CD with GitHub Actions](using-devbox-in-cicd-with-github-actions.md): This guide explains how to use Devbox in CI/CD using GitHub Actions. The will install Devbox CLI and any packages + ... - [Devbox Examples](devbox-examples.md): Devbox strives to provide a balance between the immutability of Nix's global store, and the mutability of local proje... - [Use Devbox as your Primary Package Manager](use-devbox-as-your-primary-package-manager.md): In addition to managing isolated development environments, you can use Devbox as a general package manager. Devbox Gl... - [Output:](output.md): ripgrep is now installed - [Output:](output-2.md): * ripgrep - [Output:](output-3.md): removing 'github:NixOS/nixpkgs/ripgrep' - [Devbox Env Variables](devbox-env-variables.md): The following is a list of Environment variables used by Devbox to manage your environment. Some of these variables a... - [Frequently Asked Questions](frequently-asked-questions-2.md): This doc contains answers to frequently asked questions about Devbox that are not covered elsewhere in our documentat... - [Creating a Devbox Plugin](creating-a-devbox-plugin.md): Plugins make it easier to get started with packages that require additional setup when installed with Nix, and they o... - [Installing a Specific Package Version](installing-a-specific-package-version.md): This document explains how to use and to install a specific package version in your Devbox project. It also explain... - [Installing Platform Specific Packages](installing-platform-specific-packages.md): At times, you may need to install a package or library that is only available on a specific platform. For example, yo... - [Using Plugins](using-plugins.md): This doc describes how to use Devbox Plugins with your project. provide a default Devbox configuration for a Nix pac... - [Running Scripts](running-scripts.md): Scripts are shell commands that can be defined in your devbox.json file. They can be executed by using the command. ... - [Run `lsof -i :80` in your devbox shell in quiet mode](run-lsof-i-80-in-your-devbox-shell-in-quiet-mode.md): devbox run -q lsof -i :80 - [Running Services](running-services.md): When working on an application, you often want some services or dependencies running in the background for testing. T... - [Process compose for starting django](process-compose-for-starting-django.md): version: "0.5" - [Installing Packages from Nix Flakes](installing-packages-from-nix-flakes.md): Devbox supports installing packages with . - [direnv](direnv.md): *** - [Automatically sets up your devbox environment whenever you cd into this# directory via our direnv integration:eval "$(devbox generate direnv --print-envrc --env MY_CUSTOM_ENV_VAR=my-value)"# check out https://www.jetify.com/docs/devbox/ide-configuration/direnv/# for more details](automatically-sets-up-your-devbox-environment-whenever-you-cd-into-this-director.md): You can also tell direnv to read environment variables from a custom`.env`file by passing the - [Automatically sets up your devbox environment whenever you cd into this# directory via our direnv integration:eval "$(devbox generate direnv --print-envrc --env-file .env.devbox)"# check out https://www.jetify.com/docs/devbox/ide-configuration/direnv/# for more details](automatically-sets-up-your-devbox-environment-whenever-you-cd-into-this-director-2.md): Note that if Devbox cannot find the env file provided to the flag, it will ignore the flag and load - [Eclipse IDE](eclipse-ide.md): This guide describes how to configure Eclipse to work with a devbox Java environment. - [Visual Studio Code](visual-studio-code.md): *** - [Zed Editor](zed-editor.md): Zed is a fast, open source code editor designed for collaboration and AI support, that is available for macOS and Lin... - [What is Devbox?](what-is-devbox.md): Devbox is a command-line tool that lets you easily create isolated shells for development. You start by defining the ... - [Installing Devbox](installing-devbox.md): Select your OS below for the steps to install Devbox. - [Create a Dev Environment with Devbox](create-a-dev-environment-with-devbox.md): Devbox is a command-line tool that lets you easily create reproducible, reliable dev environments. - [Welcome to Jetify Docs](welcome-to-jetify-docs.md): Find all the guides and resources you need to get started with Jetify's AI agents and developer tools - [Get a Package](get-a-package.md): GET - [Using the Nixhub API](using-the-nixhub-api.md): Version: 2.0.0 - [Resolve a Package Version](resolve-a-package-version.md): GET - [Search Packages](search-packages.md): GET - [Running scripts with Bash Tool](running-scripts-with-bash-tool.md): Learn how to use the Bash Tool in Testpilot to execute shell scripts as part of your testing workflow. - [Example YAML test case using the Bash tool](example-yaml-test-case-using-the-bash-tool.md): cases: - [./scripts/generate-test-data.sh](scriptsgenerate-test-datash.md): set -e - [Generate test data](generate-test-data.md): for i in $(seq 1 $COUNT); do - [Advanced Testpilot Features](advanced-testpilot-features.md): Advanced features for power users. Explore AI test generation, MCP integration, and specialized testing techniques. - [AI Test Generation](ai-test-generation.md): Generate comprehensive test plans automatically from natural language prompts. Create tests faster and discover edge ... - [Testpilot Best Practices](testpilot-best-practices.md): Best practices for writing effective tests. Learn optimization techniques, testing philosophy, and maintainability pa... - [How to Write Effective Tests](how-to-write-effective-tests.md): Learn tips and patterns for creating reliable, maintainable tests. Optimize test speed, use context effectively, and ... - [Testpilot Changelog](testpilot-changelog.md): Latest Testpilot updates, features, and bug fixes. Track version history and see what's new in each release. - [Evaluating Testpilot Runs](evaluating-testpilot-runs.md): Calculate key metrics from TestPilot JSON reports: latency, pass/fail rates, and cache performance across test runs. - [TestPilot JSON Report Reference](testpilot-json-report-reference.md): Complete reference for TestPilot's JSON report structure with schema, field descriptions, and enum tables. - [Getting Started with Testpilot](getting-started-with-testpilot.md): Install Testpilot and run your first AI-powered end-to-end test in minutes. Start testing web, Android, and iOS appli... - [Testing Android Apps with Testpilot](testing-android-apps-with-testpilot.md): Run automated tests on Android devices and emulators. Set up Appium, configure your device, and execute your first An... - [Testing iOS Apps with Testpilot](testing-ios-apps-with-testpilot.md): Run automated tests on iOS devices and simulators. Configure Xcode, set up your iOS simulator, and execute your first... - [Testing Web Apps with Testpilot](testing-web-apps-with-testpilot.md): Write and run your first browser-based test with Testpilot. Learn how to create test plans, execute tests, and view d... - [List of Cases to Execute](list-of-cases-to-execute.md): cases: - [How to Add Context to Testpilot Tests](how-to-add-context-to-testpilot-tests.md): Improve test accuracy by adding context to your Testpilot tests. Learn when and how to provide application details an... - [Email Testing with Mailosaur](email-testing-with-mailosaur.md): Test email registration and verification flows with Mailosaur. Generate email addresses, retrieve OTP codes, and veri... - [Testpilot Guides](testpilot-guides.md): Task-focused guides for common testing scenarios. Learn authentication, email testing, parameterization, and performa... - [Parallel Testing with Concurrency and Sharding](parallel-testing-with-concurrency-and-sharding.md): Speed up test execution by running tests in parallel. Configure concurrency for single machines and sharding across m... - [Explicit 5-way concurrency](explicit-5-way-concurrency.md): testpilot test --concurrency 5 plans/ - [Force serial execution](force-serial-execution.md): testpilot test --concurrency 1 plans/ - [First of three shards](first-of-three-shards.md): testpilot test --shard 1/3 plans/ - [Third of five shards](third-of-five-shards.md): testpilot test --shard 3/5 plans/ - [Parameterizing Tests with Environment Variables](parameterizing-tests-with-environment-variables.md): Make tests flexible and reusable with environment variables. Run the same tests across staging, development, and prod... - [Run against staging (default)](run-against-staging-default.md): testpilot test login.pilot.yaml - [Run against development](run-against-development.md): export TEST_HOST= - [Run against production](run-against-production.md): export TEST_HOST= - [In your CI/CD configuration](in-your-cicd-configuration.md): stages: - [Testing Authentication and Login Flows](testing-authentication-and-login-flows.md): Test authenticated features efficiently. Configure login credentials, set up authentication URLs, and reuse sessions ... - [Set your username and password as environment variables](set-your-username-and-password-as-environment-variables.md): export TESTPILOT_USERNAME="your-username" - [Testing Responsive Design with Viewports](testing-responsive-design-with-viewports.md): Ensure your site works across all screen sizes. Define and test multiple viewport dimensions for desktop, tablet, and... - [Testpilot: AI Powered End-to-End Testing](testpilot-ai-powered-end-to-end-testing.md): Testpilot is an AI testing agent that creates, maintains, and executes tests automatically. Test web and mobile apps ... - [Install Testpilot](install-testpilot.md): Install Testpilot in minutes. Set up the binary and configure your OpenAI API key to start running AI-powered tests. - [Testpilot GitLab CI/CD Integration](testpilot-gitlab-cicd-integration.md): Set up Testpilot in GitLab pipelines. Install the component, configure runners, and automate your tests with GitLab C... - [Include the Testpilot component](include-the-testpilot-component.md): include: - [Define pipeline stages](define-pipeline-stages.md): stages: - [Your test job](your-test-job.md): run-my-tests: - [macOS runner configuration](macos-runner-configuration.md): .macos_saas_runners: - [Include the Testpilot component for macOS](include-the-testpilot-component-for-macos.md): include: - [Define pipeline stages](define-pipeline-stages-2.md): stages: - [Run your tests on macOS](run-your-tests-on-macos.md): run-tests-macos: - [Custom runner configurations](custom-runner-configurations.md): .arm_runner: - [Runner configurations](runner-configurations.md): .macos_saas_runners: - [Install Testpilot on both platforms](install-testpilot-on-both-platforms.md): include: - [Run tests on Linux](run-tests-on-linux.md): test-linux: - [Run tests on macOS](run-tests-on-macos.md): test-macos: - [Merge your test reports together into a single artifact](merge-your-test-reports-together-into-a-single-artifact.md): testpilot_merge: - [Testpilot CI/CD Integrations](testpilot-cicd-integrations.md): Integrate Testpilot with your CI/CD pipeline. Set up automated testing in GitLab, GitHub Actions, and other platforms. - [Model Context Protocol (MCP) Integration](model-context-protocol-mcp-integration.md): Extend Testpilot with MCP servers. Connect to internal APIs, custom scripts, and specialized tools to enhance testing... - [Restrict GitHub MCP tools to read-only permissions.](restrict-github-mcp-tools-to-read-only-permissions.md): GH_MCP_SERVER= testpilot test - [Pilotfile Reference](pilotfile-reference.md): Complete reference for Testpilot pilot files. Learn the file format, configuration options, and test case structure. - [Load from a direct URL](load-from-a-direct-url.md): testpilot run - [Load from GitHub](load-from-github.md): testpilot run - [Testpilot CLI Reference](testpilot-cli-reference.md): Complete command-line reference for Testpilot. Learn all CLI commands, options, and flags for running and managing te... - [testpilot](testpilot.md): Testpilot CLI - AI-powered end-to-end testing tool - [testpilot auth](testpilot-auth.md): Manage your account - [testpilot auth login](testpilot-auth-login.md): Log in to your account - [Log in to your account](log-in-to-your-account.md): testpilot auth login - [testpilot auth logout](testpilot-auth-logout.md): Log out from your account - [Log out from your account](log-out-from-your-account.md): testpilot auth logout - [testpilot auth whoami](testpilot-auth-whoami.md): Show information about the current user - [Show current user information](show-current-user-information.md): testpilot auth whoami - [Show user information including tokens](show-user-information-including-tokens.md): testpilot auth whoami --show-tokens - [testpilot generate](testpilot-generate.md): Generate a pilot plan from a prompt - [Generate a pilot plan for testing login functionality](generate-a-pilot-plan-for-testing-login-functionality.md): testpilot generate "Test user login with valid and invalid credentials" - [Generate a plan with context from files](generate-a-plan-with-context-from-files.md): testpilot generate "Test checkout process" --context ./api-docs.md --context ./user-guide.md - [Generate a plan and save to a specific directory](generate-a-plan-and-save-to-a-specific-directory.md): testpilot generate "Test search functionality" --outdir ./tests/search - [testpilot install](testpilot-install.md): Download and install dependencies - [Force reinstall dependencies](force-reinstall-dependencies.md): testpilot install --force - [testpilot report](testpilot-report.md): Manage test reports - [testpilot report merge](testpilot-report-merge.md): Merge multiple test reports into a single report - [Merge two report directories](merge-two-report-directories.md): testpilot report merge ./reports1 ./reports2 - [Merge multiple report directories](merge-multiple-report-directories.md): testpilot report merge ./reports1 ./reports2 ./reports3 - [Merge reports and save to a custom output directory](merge-reports-and-save-to-a-custom-output-directory.md): testpilot report merge ./reports1 ./reports2 --outdir ./merged-reports - [testpilot test](testpilot-test.md): Test the scenarios in the provided pilot plans - [Run all tests in the current directory](run-all-tests-in-the-current-directory.md): testpilot test - [Run tests from a specific pilot plan file](run-tests-from-a-specific-pilot-plan-file.md): testpilot test ./my-test.pilot.yaml - [Run tests from a specific directory](run-tests-from-a-specific-directory.md): testpilot test ./tests/ - [Run only tests with names containing "login"](run-only-tests-with-names-containing-login.md): testpilot test --filter login - [Run tests and save reports to a custom directory](run-tests-and-save-reports-to-a-custom-directory.md): testpilot test --outdir ./test-results - [Run tests in shard 1 of 3 total shards](run-tests-in-shard-1-of-3-total-shards.md): testpilot test --shard 1/3 - [testpilot version](testpilot-version.md): Print version information - [Print detailed version information](print-detailed-version-information.md): testpilot version --verbose - [testpilot version update](testpilot-version-update.md): Update launcher and binary - [Update Testpilot to the latest version](update-testpilot-to-the-latest-version.md): testpilot version update