Skip to content

Quickstart

Install the CLI, run Polygraph, and start your first session.

Terminal window
npm install -g polygraph@latest

Start with the interactive CLI. It guides you through sign-in, account selection, and session setup.

Terminal window
polygraph

After sign-in, confirm the effective account before starting a session.

Terminal window
polygraph whoami

If you want to run the sign-in flow directly, use the auth command.

Terminal window
polygraph auth login

A session coordinates work across one or more repos.

Terminal window
polygraph session start

The session comes with an ID and an URL. For example, foo-bar-00ff00ff and https://app.trypolygraph.com/orgs/<org-id>/sessions/foo-bar-00ff00ff. You can use the ID to resume a session, and the URL to inspect the session.

Inside a session, you can prompt the agent to add additional repos to the session.

For example,

Please add vitejs/vite repo to this session.

You can add any public repos or repos that you own to the session.

Alternatively, use the CLI to add a repo to an active session.

Terminal window
polygraph session add-repo vitejs/vite --session <session-id>
Terminal window
polygraph session list

Show details such as URL, folder, and status for a session.

Terminal window
polygraph session show <session-id>

Pick a workflow that matches what you want to do.