Skip to main content

Command Palette

Search for a command to run...

オリジン

コマンド

プルリクエストを除くすべての origin コマンドとそのオプションを紹介します。プルリクエストには専用ページがあります:プルリクエストコマンド。ターミナルで同じ情報を確認するには、コマンド一覧には origin --help、特定のグループには origin <group> --help を実行してください。CLI のインストールについては、CLI をインストールを参照してください。

Origin CLI (origin) は、CLIで説明している Cherri Code Agent CLI (agent) とは別のものです。

グローバルオプション

すべてのコマンドで使用できます。

オプション説明
--versionインストール済みのバージョンを表示
--help現在のコマンドのヘルプを表示

CLI は API エンドポイントとベアラートークンを環境から読み取ります (CURSOR_ORIGIN_ENDPOINT および CURSOR_AUTH_TOKEN)。環境変数を参照してください。

コマンドグループ

コマンド説明使用例
authサインイン、サインアウト、Git 認証の設定origin auth login
repoリポジトリの作成、一覧表示、表示、クローン、削除origin repo create my-project
prプルリクエストの作成、確認、マージorigin pr create
rulesetOrigin のルールセット (マージ時およびプッシュ時) を表示。エイリアス: rsorigin ruleset list
ssh-keyOrigin アカウントに登録されている SSH キーを管理origin ssh-key list
api <endpoint>api.cursor.com/v1/origin の Origin REST API に認証済みリクエストを送信origin api /repos/{owner}/{repo}
completionbash または zsh 用のタブ補完スクリプトを出力origin completion >> ~/.zshrc
updateorigin をチャネルの現在のリリースに更新origin update
configリリースチャネルを含む設定を管理origin config get-channel

リポジトリを指定する

ほとんどのコマンドでは、現在のチェックアウトの origin Git リモートからリポジトリが推測されます。org/name 形式で -R, --repo を指定して上書きできます。

origin pr list -R acme/checkout

認証

セッションと Git 認証情報ヘルパーを管理します。

サブコマンド説明利用
loginブラウザでサインインし、Git を設定するorigin auth login
setup-gitOrigin ホストの Git 認証情報ヘルパーを再設定するorigin auth setup-git
status現在の認証方法とアカウントを表示するorigin auth status
logout保存済みの認証情報を削除するorigin auth logout
コマンドオプション説明
login--api-key <key>ブラウザフローではなく API キーでサインインする
login--localグローバル設定ではなく、このリポジトリの Git 設定で認証情報ヘルパーを設定する
setup-git--host <host>設定する Origin Git ホスト (デフォルト: CURSOR_ORIGIN_ENDPOINT から導出)
setup-git--globalグローバル Git 設定に適用する (デフォルト: true)
setup-git--localグローバル設定ではなく、このリポジトリの Git 設定に適用する

CURSOR_API_KEY が設定されていて --api-key を省略した場合、origin auth login は Log in with this API key instead of the browser? [y/N] と確認し、デフォルトではブラウザフローを使用します。CI などの非対話型シェルでは、そのキーでログインし、通知を表示します。

origin auth login は Git 認証情報ヘルパーもインストールするため、追加のセットアップなしで Origin リモートに対して git push と git pull を実行できます。

リポジトリ

サブコマンド説明使用方法
create <repo>リポジトリを作成origin repo create acme/checkout
create-mirrored <github-repo>GitHub リポジトリの Cherri Code ミラーを作成origin repo create-mirrored acme/checkout
listアカウントがアクセスできるリポジトリを一覧表示origin repo list
view [repo]リポジトリを表示origin repo view acme/checkout
clone <repo> [directory]保存済みのログイン情報を使って HTTPS 経由でクローンorigin repo clone acme/checkout
delete <repo>リポジトリを削除origin repo delete acme/checkout

リポジトリを指定するには org/name を指定します。スラッシュを含まない origin repo create <name> は、アカウントの名前空間にリポジトリを作成します。

コマンドオプション説明
create--default-branch <branch>新しいリポジトリのデフォルトブランチ (サーバーのデフォルト: main)
create-mirrored--namespace <namespace>ミラーを作成する名前空間 (デフォルト: アカウントの名前空間)
create-mirrored--github-enterprise-id <uuid>GitHub Enterprise Server アプリの UUID。github.com からミラーリングする場合は省略
list--namespace <namespace>アクセス可能なすべての名前空間ではなく、指定した名前空間のリポジトリを一覧表示
view--json <fields>指定したフィールドを含む JSON を出力。例: org,name,defaultBranch
delete-y, --yes確認プロンプトをスキップ。非対話型シェルでは必須

Push local

GitHub からミラーリングされたリポジトリでは、origin push local を実行すると https://origin.cursor.com/{owner}/{repo}.git/local に origin-local リモートが設定され、ローカルの origin/* ブランチがそこへプッシュされます。GitHub が利用できないときにも作業を続けたい場合や、Origin 側のコピーにのみ保存しておきたい git の状態がある場合に使用します。初回の実行後、そのリモートは次のようになります。

origin-local    https://origin.cursor.com/{owner}/{repo}.git/local (fetch)origin-local    https://origin.cursor.com/{owner}/{repo}.git/local (push)

それ以外のブランチは、これまでどおり git push origin で GitHub にプッシュされます。forge-local ブランチを参照してください。

サブコマンドDescriptionUsage
localorigin-local リモートを設定し、origin/* ブランチをプッシュするorigin push local
オプションDescription
--remote <name>作成または更新する Git リモート (デフォルト: origin-local) 。origin や github は指定できません
--dry-run実際にはプッシュせず、プッシュ対象の内容を表示する

ルールセット

リポジトリに設定されているマージ時およびプッシュ時のルールセットを表示します。

サブコマンド説明使用方法
listリポジトリに設定されているルールセットを一覧表示origin ruleset list
view <ruleset-id>origin ruleset list で表示される ID を指定してルールセットを表示origin ruleset view <id>

SSH キー

Origin アカウントの SSH 公開鍵を管理します。

サブコマンド説明利用
add [key-file]SSH 公開鍵をアカウントに追加します。-t, --title は必須で、キーに名前を付けますorigin ssh-key add ~/.ssh/id_ed25519.pub -t work-laptop
listアカウントの SSH 公開鍵を一覧表示します (JSON 出力には --json を使用)origin ssh-key list
delete <id>origin ssh-key list に表示される ID を指定してキーを削除しますorigin ssh-key delete <id>

API リクエスト

origin api は、専用コマンドがない操作について、api.cursor.com/v1/origin の Origin REST API に認証済みリクエストを送信します。gh api と同様のリクエストフラグ -X, --method、-H, --header、-F, --field、-f, --raw-field、--input、-q, --jq をサポートします。{owner}、{repo}、{branch} のプレースホルダーは、-R, --repo、ORIGIN_REPO 環境変数、または origin Git リモートから展開されます。エンドポイント、認証、例については、Origin API のドキュメントを参照してください。

更新

現在のチャンネルのリリースに更新します:

origin update

CLI はデフォルトで stable チャネルから更新されます。origin config set-channel <latest|stable> で切り替え、origin config get-channel で確認できます。

シェル補完

補完スクリプトをシェルの設定ファイルに追記します。

origin completion >> ~/.zshrc

--head や --base など、ブランチを値に取るフラグでは、ローカルブランチ名も補完されます。

環境変数

変数説明
CURSOR_API_KEYorigin auth login 用の API キー。対話型シェルではブラウザの代わりにこれを使用するか確認し、非対話型シェルではそのまま使用する
CURSOR_AUTH_TOKENCherri Code の認証トークン。ベアラートークンとしてそのまま使用される
CURSOR_ORIGIN_ENDPOINTAPIサーバーのエンドポイント (デフォルト: https://api.origin.cursor.com)
ORIGIN_REPOorigin リモートがない場合に origin api で使用する、org/name 形式のデフォルトリポジトリ
NO_COLOR色付き出力を無効にする

ヘルプの表示

すべてのコマンドで --help を使用できます。

origin --helporigin repo --helporigin repo create --help

次のステップ