Skip to content

Quickstart

From nothing to a working query in about five minutes.

1. Install

irm https://pub-bbeb86c46454443ca76521dd4d29818e.r2.dev/install.ps1 | iex

curl -fsSL https://pub-bbeb86c46454443ca76521dd4d29818e.r2.dev/install.sh | sh

The prebuilt binary bundles Python — nothing else to install. See Install for uv and from-source options, and for managed machines where the binary is blocked.

2. Open a new shell

So your PATH picks up crm, then confirm:

crm --version

3. Create a profile

crm profile add

On a terminal this runs a wizard: enter your server URL, and the CLI infers the auth scheme (any host containing .dynamics. → OAuth, anything else → NTLM), prompts for what that scheme needs, runs a WhoAmI to verify before saving anything, then stores the secret and activates the profile. See Add a profile for the non-interactive form and what happens if the live test fails.

4. Confirm it works

crm connection whoami
crm query odata accounts --top 5

If whoami prints your user and organization, you're connected.

Next: