Files
pr-agent/docs/docs/usage-guide/introduction.md
Tal 28ea4a685a Update docs/docs/usage-guide/introduction.md
Co-authored-by: codiumai-pr-agent-pro[bot] <151058649+codiumai-pr-agent-pro[bot]@users.noreply.github.com>
2024-07-18 11:05:35 +03:00

1.2 KiB

After installation, there are three basic ways to invoke CodiumAI PR-Agent:

  1. Locally running a CLI command
  2. Online usage - by commenting on a PR
  3. Enabling PR-Agent tools to run automatically when a new PR is opened

Specifically, CLI commands can be issued by invoking a pre-built docker image, or by invoking a locally cloned repo.

For online usage, you will need to setup either a GitHub App or a GitHub Action (GitHub), a GitLab webhook (GitLab), or a BitBucket App (BitBucket). These platforms also enable to run PR-Agent specific tools automatically when a new PR is opened, or on each push to a branch.