Skip to main content

Official websites use .gov
A .gov website belongs to an official government organization in the United States.

Secure .gov websites use HTTPS
A lock ( ) or https:// means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites.

Setup Instructions

curl and jq are tools you can use to access the AB2D sandbox and production environments. curl comes preinstalled on some operating systems. In a terminal, type curl --version to check if it’s installed.

If you don’t have it installed, use the following system-specific instructions to install jq and curl. If your operating system isn’t listed, follow the installation instructions on the curl and jq websites.

Mac

  1. Install or update jq using Homebrew:
    • If you have already installed jq, you may receive and ignore the following warning:
  2. You can verify if jq is installed if you enter the following and receive a version number in response. Any version of jq will work for this set up.

Linux (CentOS/RedHat)

The following instructions are intended for systems using yum as the package installer. In the case of other Linux distributions with alternative package managers, please use the equivalent package manager command(s) to install jq.

  1. Install jq:
  2. You can verify if jq is installed if you enter the following and receive a version number in response. Any version of jq will work for this set up.

Windows 10 and 11

In this example, we will be using the Linux Subsystem for Windows 10.

  1. Select Type here to search near the bottom left of your Windows desktop.
  2. Enter the following in the text box:
  3. Select Turn Windows features on or off from the leftmost panel.
  4. Scroll down to and check Windows Subsystem for Linux. If it is already installed, skip to step 10 to install Ubuntu.
  5. Select OK on the Windows Features window.
  6. Wait for the changes to complete. If installation is successful, skip to step 9.
  7. If the installation is unsuccessful, open the PowerShell or Windows Command Prompt in administrator mode by right-clicking and selecting Run as administrator.
  8. Enter the following in your terminal:
  9. When prompted, restart your system.
  10. Select Type here to search again.
  11. Enter the following in the text box:
  12. Select Microsoft Store from the leftmost panel.
  13. Select Search on the Microsoft Store page.
  14. Enter the following in the text box:
  15. Select Run Linux on Windows.
  16. Select Ubuntu.
  17. Select Get.
  18. Select No, thanks on the Use across your devices dialog. The installation will begin automatically.
  19. Once the installation is complete, select Launch.
  20. When prompted, choose a username and password.
  21. If the installation is successful, you will have a prompt that looks like this:
  22. You’ll be entering commands at the dollar sign prompt ($). The easiest way to do this is to copy and paste. Update the Ubuntu system by entering the command:
  23. Install jq by entering this command at the dollar sign prompt:
  24. When prompted, enter your password.
  25. Wait for the installation to complete.
  26. You can verify if jq is installed if you enter the following and receive a version number in response. Any version of jq will work for this set up.
Looking for U.S. government information and services?
Visit USA.gov