espaguette/cli

A CLI tool to execute commands based on a JSON configuration.

v1.0.1 2025-01-30 04:32 UTC

Requires

• symfony/console: ^7.2

MIT

• Julyano Silva

README

Espaguette CLI é uma ferramenta que permite definir e executar comandos personalizados através de um arquivo de configuração JSON. Ela simplifica a execução de tarefas comuns do projeto, oferecendo uma interface interativa para selecionar e executar comandos pré-configurados.

Recursos

• Menu Interativo: Navegue através dos comandos disponíveis utilizando as setas do teclado.
• Configuração Flexível: Permite adicionar, remover ou modificar comandos facilmente no arquivo espaguette.json.
• Fácil Utilização: Executa os comandos diretamente no terminal.
• Flexível: Permite utilizar qualquer comando, não estando limitado à comandos PHP.

Requisitos

• PHP 8.0 ou superior
• Composer

Instalação

1. Instale via Composer (Global):

composer global require espaguette/cli

1. Certifique-se de que o diretório global bin está no seu PATH. Para adicioná-lo, inclua no seu .bashrc, .zshrc ou .bash_profile:

export PATH="$HOME/.config/composer/vendor/bin:$PATH"

1. Recarregue o seu ambiente:

source ~/.bashrc  # ou source ~/.zshrc ou source ~/.bash_profile

1. Crie um arquivo espaguette.json na raiz do seu projeto:

{
    "comando1": "Descrição do comando 1",
    "comando2": "Descrição do comando 2"
}

Uso

1. Crie o arquivo espaguette.json na raiz do seu projeto. Na raiz do seu projeto, crie o arquivo espaguette.json com seus comandos e descrições. Exemplo:

{
    "bin/cake SincronizarPedidos": "Sincroniza os pedidos do sistema X",
    "php artisan mail:send": "Envia os e-mails pendentes"
}

1. Execute a ferramenta:

espaguette

Você verá o menu interativo parecido com este:

Select a command to execute:
    [0] bin/cake SincronizarPedidos - Sincroniza os pedidos do sistema X
    [1] php artisan mail:send - Envia os e-mails pendentes
>

Utilize as setas up/down para navegar pelos comandos e pressione Enter para executar.

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para mais detalhes.

Autor

• Julyano Silva - [e-mail]