Skip to content

Access

You can access Scope through the web Portal, the REST API, or the scope CLI.

This page assumes you have access to an existing deployment. To run Scope yourself, follow Local development for prerequisites, setup, authentication, and a first evaluation.

Your deployment administrator provides the Portal URL and any required authentication details.

Open the Portal URL provided for your deployment. For example:

https://your-scope.example.com

Open the URL in any modern browser. The Portal is the entry point for submitting requests, browsing results, and managing task prompts, criteria, profiles, and prompt features.

The REST API is available at the same host under /api/v1. See Submitting requests (REST API) for endpoint examples.

You don’t need to install anything to use the Portal.

Your deployment may require credentials to run coding agents or pull skills from GitHub repositories. Contact your deployment administrator for the required setup, or see Manage provider credentials to add provider keys yourself.

For terminal-based workflows, install the scope CLI:

Terminal window
curl --fail --location https://raw.githubusercontent.com/microsoft/scope/main/install-cli.sh | bash

Installing the public CLI does not require GitHub authentication. Using your deployment’s API still requires its configured authentication.

See Install the CLI for details.