Install from the .NET Core CLI

Link to Install from the .NET Core CLI copied to clipboard
Not for use with personal data

Access and install axe DevTools from your CLI

In order to download axe DevTools, follow the registry access instructions provided by your development operations department. This nuget.config example file will guide you through setting up the dependencies to download axe DevTools from Deque's Agora.

Step 1: Open your CLI and navigate to your project directory.

Step 2: Create a nuget.config file if it is not currently present using this command

dotnet new nugetconfig

If you do not wish to store this information inside your code repository you can skip this and use the user config file (C:\Users\username\AppData\Roaming\NuGet\NuGet.Config)

Step 3: Add Deque's Agora Artifactory instance as a package source.

Step 4: Add the following snippet to your config file inside the <packageSources> section after the <add> with key="nuget.org":

<add key="Artifactory" value="https://agora.dequecloud.com/artifactory/api/nuget/devtools-nuget" />

Step 5: Add your Agora credentials to your config file via the following snippet in the <configuration> tag, replacing <USERNAME> and <IDENTITY_TOKEN> with your credentials. The username will be the email address used to log into Agora. You can create a new Identity Token by logging into Agora, clicking the welcome banner in the top right corner, choosing Edit Profile, clicking on Generate an Identity Token, following the steps, and copying your Identity Token. If you do not have Agora login credentials, contact your Deque representative.

important

Remember to copy your Identity Token's value when creating it, as this will be your only opportunity. Otherwise, you'll have to create a new token.

Identity Tokens expire (usually after a year), so you'll need to recreate your token periodically.

 <packageSourceCredentials>
    <Artifactory>
        <add key="Username" value="<USERNAME>" />
        <add key="ClearTextPassword" value="<IDENTITY_TOKEN>" />
    </Artifactory>
  </packageSourceCredentials>
note

The use of a clear text Identity Token is necessary; encrypted passwords are not supported on non-Windows platforms.

Step 6: Install axe-devtools-selenium:

dotnet add package axe-devtools-selenium

You should now see axe-devtools-selenium mentioned in your csproj file.

Dotnet Dependencies

Dependencies are automatically downloaded and built when you build or test the main project in Visual Studio. You can accomplish the same steps using the dotnet CLI via the following command:

dotnet restore

JavaScript dependencies are automatically downloaded and resolved when building the main project.

Build

To build the project, use the command dotnet build.

Test

To test the project, use the command dotnet test.

Is this page helpful?

Help us improve this page

Still need help?