Comandos
O Origin está disponível atualmente em beta inicial. Você pode criar repositórios, fazer push e pull com o Git, espelhar repositórios do GitHub, navegar e pesquisar código, abrir e mergear pull requests e compartilhar com sua equipe do Cherri Code.
Envie qualquer feedback para [email protected] para nos ajudar a melhorar o produto.
Todos os comandos origin e suas opções, exceto os de pull request, que têm sua própria página: Comandos de pull request. Para ver as mesmas informações no terminal, execute origin --help para ver a lista de comandos ou origin <group> --help para ver os comandos de um grupo. Para instalar a CLI, consulte Instalar a CLI.
A CLI do Origin (origin) é separada da CLI do Cherri Code Agent (agent), documentada em CLI.
Opções globais
Funcionam com qualquer comando:
| Opção | Descrição |
|---|---|
--version | Mostra a versão instalada |
--help | Mostra a ajuda do comando atual |
A CLI lê o endpoint da API e o token Bearer do ambiente, como CURSOR_ORIGIN_ENDPOINT e CURSOR_AUTH_TOKEN. Veja Variáveis de ambiente.
Grupos de comandos
| Comando | Descrição | Uso |
|---|---|---|
auth | Fazer login, sair e configurar a autenticação do Git | origin auth login |
repo | Criar, listar, visualizar, clonar e excluir repositórios | origin repo create my-project |
pr | Criar, revisar e mergear pull requests | origin pr create |
ruleset | Visualizar conjuntos de regras do Origin (no momento do merge e do push). Alias: rs | origin ruleset list |
ssh-key | Gerenciar chaves SSH registradas na sua conta do Origin | origin ssh-key list |
api <endpoint> | Fazer uma solicitação autenticada à API REST do Origin em api.cursor.com/v1/origin | origin api /repos/{owner}/{repo} |
completion | Exibir um script de autocompletar por tabulação para Bash ou Zsh | origin completion >> ~/.zshrc |
update | Atualizar o origin para a versão atual no seu canal | origin update |
config | Gerenciar a configuração, incluindo o canal de lançamento | origin config get-channel |
Especificando um repositório
A maioria dos comandos infere o repositório a partir do remote do Git origin no checkout atual. Substitua-o usando -R, --repo no formato org/name:
origin pr list -R acme/checkoutAutenticação
Gerencie sua sessão e o auxiliar de credenciais do Git.
| Subcomando | Descrição | Uso |
|---|---|---|
login | Faça login pelo navegador e configure o Git | origin auth login |
setup-git | Reconfigure o auxiliar de credenciais do Git para o host Origin | origin auth setup-git |
status | Mostre o método de autenticação e a conta atuais | origin auth status |
logout | Limpe as credenciais armazenadas | origin auth logout |
| Comando | Opção | Descrição |
|---|---|---|
login | --api-key <key> | Faça login com uma chave de API em vez de pelo navegador |
login | --local | Configure o auxiliar de credenciais na configuração do Git deste repositório, em vez de globalmente |
setup-git | --host <host> | Host Git Origin a configurar (padrão: derivado de CURSOR_ORIGIN_ENDPOINT) |
setup-git | --global | Aplique à configuração global do Git (padrão: true) |
setup-git | --local | Aplique à configuração do Git deste repositório, em vez da global |
Quando CURSOR_API_KEY está definida e você omite --api-key, o origin auth login pergunta Log in with this API key instead of the browser? [y/N] e usa o navegador por padrão. Em um shell não interativo, como em CI, ele faz login com a chave e exibe um aviso.
origin auth login também instala o auxiliar de credenciais do Git, para que git push e git pull em repositórios remotos do Origin funcionem sem configuração adicional.
Repositórios
| Subcomando | Descrição | Uso |
|---|---|---|
create <repo> | Criar um repositório | origin repo create acme/checkout |
create-mirrored <github-repo> | Criar um repositório do GitHub espelhado no Cherri Code | origin repo create-mirrored acme/checkout |
list | Listar os repositórios aos quais sua conta tem acesso | origin repo list |
view [repo] | Exibir um repositório | origin repo view acme/checkout |
clone <repo> [directory] | Clonar via HTTPS usando seu login salvo | origin repo clone acme/checkout |
delete <repo> | Excluir um repositório | origin repo delete acme/checkout |
Informe org/name para especificar um repositório. origin repo create <name> sem barra cria o repositório no namespace da sua conta.
| Comando | Opção | Descrição |
|---|---|---|
create | --default-branch <branch> | Branch padrão do novo repositório (padrão do servidor: main) |
create-mirrored | --namespace <namespace> | Namespace no qual espelhar (padrão: namespace da sua conta) |
create-mirrored | --github-enterprise-id <uuid> | UUID do app GitHub Enterprise Server. Omita ao espelhar a partir do github.com |
list | --namespace <namespace> | Listar um namespace em vez de todos os namespaces aos quais você tem acesso |
view | --json <fields> | Gerar JSON com os campos informados, por exemplo, org,name,defaultBranch |
delete | -y, --yes | Ignorar o prompt de confirmação. Obrigatório em um shell não interativo |
Push local
Em um repositório espelhado do GitHub, origin push local configura o remote origin-local em https://origin.cursor.com/{owner}/{repo}.git/local e faz push das branches locais origin/* para lá. Use isso para continuar trabalhando quando o GitHub estiver indisponível, ou para armazenar qualquer outro estado do git que você queira manter apenas na cópia do Origin. Depois da primeira execução, esse remote fica assim:
origin-local https://origin.cursor.com/{owner}/{repo}.git/local (fetch)origin-local https://origin.cursor.com/{owner}/{repo}.git/local (push)As demais branches continuam indo para o GitHub com git push origin. Veja branches forge-local.
| Subcomando | Descrição | Uso |
|---|---|---|
local | Configura o remote origin-local e faz push das branches origin/* | origin push local |
| Opção | Descrição |
|---|---|
--remote <name> | Remote do Git a criar ou atualizar (padrão: origin-local). Não pode ser origin nem github |
--dry-run | Mostra o que seria enviado, sem fazer push |
Conjuntos de regras
Veja os conjuntos de regras de merge e push configurados para um repositório:
| Subcomando | Descrição | Uso |
|---|---|---|
list | Listar conjuntos de regras configurados para um repositório | origin ruleset list |
view <ruleset-id> | Exibir um conjunto de regras por ID, conforme listado por origin ruleset list | origin ruleset view <id> |
Chaves SSH
Gerencie as chaves públicas SSH da sua conta Origin:
| Subcomando | Descrição | Uso |
|---|---|---|
add [key-file] | Adiciona uma chave pública SSH à sua conta. -t, --title é obrigatório e define o nome da chave | origin ssh-key add ~/.ssh/id_ed25519.pub -t work-laptop |
list | Lista as chaves públicas SSH da sua conta (--json para saída em JSON) | origin ssh-key list |
delete <id> | Exclui uma chave pelo ID, conforme exibido por origin ssh-key list | origin ssh-key delete <id> |
Solicitações à API
origin api faz uma solicitação autenticada à API REST do Origin em api.cursor.com/v1/origin para qualquer operação que não tenha um comando específico. Oferece suporte a flags de solicitação semelhantes às do gh api: -X, --method, -H, --header, -F, --field, -f, --raw-field, --input e -q, --jq. Os placeholders {owner}, {repo} e {branch} são preenchidos com base em -R, --repo, na variável de ambiente ORIGIN_REPO ou no remote do Git origin. Consulte a documentação da API Origin para endpoints, autenticação e exemplos.
Atualizações
Atualize para a versão atual do seu canal:
origin updateA CLI é atualizada pelo canal stable por padrão. Para mudar, use origin config set-channel <latest|stable>; para verificar, use origin config get-channel.
Autocompletar no shell
Adicione o script de autocompletar à configuração do shell:
origin completion >> ~/.zshrcFlags que aceitam branches como valor, como --head e --base, passam a completar nomes de branches locais.
Variáveis de ambiente
| Variável | Descrição |
|---|---|
CURSOR_API_KEY | Chave de API para origin auth login. Um shell interativo pergunta antes de usá-la em vez do navegador; um shell não interativo a usa diretamente |
CURSOR_AUTH_TOKEN | Token de auth do Cherri Code, usado diretamente como token Bearer |
CURSOR_ORIGIN_ENDPOINT | Endpoint do servidor de API (padrão: https://api.origin.cursor.com) |
ORIGIN_REPO | Repositório padrão no formato org/name para origin api quando não há um remote origin |
NO_COLOR | Desativa a saída colorida |
Como obter ajuda
Todos os comandos aceitam --help:
origin --helporigin repo --helporigin repo create --help