xenogit

Seu amigo CLI para mensagens instantâneas de commit do Git.

Introdução

Xenogit é seu assistente de linha de comando útil que usa OpenAI GPT para criar rapidamente mensagens de commit que seguem a especificação de commit convencional. Pare de perder tempo escrevendo commits e comece a gerenciar seu repositório Git sem esforço!

️Primeiros passos

Instalando

Existem duas maneiras de instalar o Xenogit:

1. Usando o Composer: Execute o seguinte comando para instalar o Xenogit globalmente:

composer global require dotninth/xenogit

2. Baixando do GitHub: Visite a página Releases no GitHub e baixe o binário apropriado.

Uso

Depois de instalar o Xenogit, você pode obter todas as opções disponíveis simplesmente iniciando o programa:

$ xenogit

  Xenogit  v1.3.2

  USAGE:  < command > [options] [arguments]

  commit         Automatically generate commit messages

  config:api-key Configure the API key in the .env file

Chave de API

O Xenogit precisa de uma chave API da OpenAI para funcionar corretamente. Existem duas opções para fornecer a chave de API:

1. Use o comando xenogit config:api-key <your-api-key> .

2. Usando variável de ambiente: Crie uma variável de ambiente chamada API_KEY que contém sua chave de API OpenAI.

3. Crie um arquivo chamado .env no diretório onde o binário Xenogit está localizado. Este arquivo será usado para armazenar suas variáveis ​​de ambiente. Ao arquivo .env , adicione a seguinte linha, substituindo <YOUR_API_KEY> pela sua chave de API OpenAI real:

API_KEY= < YOUR_API_KEY > 

Pagamento

Usar o Xenogit custará dinheiro para cada solicitação feita à API OpenAI. O Xenogit usa o modelo oficial ChatGPT ( gpt-3.5-turbo-16k ), que custa aproximadamente 15 vezes menos que o GPT-4. Certifique-se de ter fundos ou créditos suficientes em sua conta OpenAI para pagar pelo uso do Xenogit.

Para saber mais sobre o preço de uso dos serviços da OpenAI, verifique a página de preços na página de preços da OpenAI.

Contribuir

Você está convidado a contribuir com o Xenogit! Para uma colaboração tranquila, siga estas diretrizes ao contribuir para o projeto:

1. Bifurque o repositório e clone-o em sua máquina local.
2. Crie um novo branch para sua contribuição: git checkout -b my-contribution .
3. Faça suas alterações, certificando-se de que o código siga o estilo e as convenções de codificação do projeto.
4. Teste suas alterações completamente.
5. Confirme suas alterações com uma mensagem de commit descritiva, seguindo a especificação de commit convencional.
6. Envie seu branch para seu repositório bifurcado: `git push origin my-contribution'.
7. Abra uma solicitação pull na ramificação `principal' do repositório Xenogit.
8. Forneça uma descrição clara e detalhada de suas alterações na solicitação pull, juntamente com qualquer informação ou contexto relevante.

Observe que ao contribuir para o Xenogit, você concorda em liberar suas contribuições sob a licença MIT.

Licença

Xenogit é lançado sob a licença MIT. Sinta-se à vontade para modificá-lo e distribuí-lo de acordo com suas necessidades.