devpilot-core

DevPilot 🚀👨🏽‍🚀

Documentação - 🇧🇷 Português

---

Sumário

• Funcionalidades
• Uso
• Flags
• Usando a partir do NPM
• Criando CLI
• Versão 1.0.5

---

DevPilot é um gerador de CLIs que permite criar, abrir e gerenciar CLIs de forma simples, com suporte a comandos personalizados e plugins.

Funcionalidades

• Criar novos CLIs automaticamente (createCLI).
• Adicionar comandos aos CLIs existentes.
• Flags globais:
  • --help para exibir instruções.
  • --version para ver a versão do DevPilot.
  • --doc para exibir documentação
• Build automático para cada CLI criado.

Como usar?

1. Clone este repositório:

git clone https://github.com/LucasPaulo001/DevPilot.git

2. Vá para a branch de desenvolvimento

git checkout feature-devp/configs

3. Na raiz do projeto instale as dependências

npm install

4. Gere a dist para melhores testes (O projeto buildado é a melhor opção para testes diretos do terminal)

npm run build

5. Agora é só rodar o index da dist com o comando

npm start

---

Testando as flags (comandos globais)

1. Rode o projeto direto da dist utilizando o node com as flags

Para ajuda

node dist/cli/index.js --help

Para verificar a versão do DevPilot

node dist/cli/index.js --v

ou

node dist/cli/index.js --version

Para ter acesso à documentação

node dist/cli/index.js --doc

---

Usando o DevPilot a partir do npm

1. Baixe o DevPilot globalmente

npm install devpilot-core -g

2. Agora inicialize o devpilot e crie o projeto base para o seu CLI

devpilot

---

As flags globais a partir do npm são:

1. Ajuda

devpilot --help

2. Documentação

devpilot --doc

3. Versão

devpilot --version

---

Criando Meu CLI

Ao gerar um CLI teremos vários arquivos:

meu-cli

• ├── src/
• | ├── dist/
• │ ├── cli/
• │ │ └── index.ts
• │ ├── commands/
• │ │ ├── hello.ts
• │ │ ├── ping.ts
• | └── devpilot.config.yaml
• ├── package.json
• └── tsconfig.json

index.ts é o ponto de partida para a criação da interface de comandos do CLI.
É nele que vamos criar o questionário principal para os comandos.

A pasta commands é onde ficarão nossos comandos, ou seja, onde fica a automação que vamos construir para o CLI.

---

Versão 1.0.5 de 16/08/2025

Sobre a versão:

Funcionalidade	Descrição
Criação de Flags	Agora o usuário pode gerar flags de formasimples, apenas pelo menu interativo!
Campo de ajuda do Devpilot	Janela de ajuda com visual novo
Melhorias de inicialização do CLI	Dependências baixadas juntamente com build do CLI gerado sem necessidade de instalação de dependência extra

---

Documentation - 🇺🇸 English

---

Table of Contents

• Features
• Usage
• Flags
• Using via NPM
• Creating CLI
• Version 1.0.5

---

DevPilot is a CLI generator that allows you to create, open, and manage CLIs easily, with support for custom commands and plugins.

Features

• Automatically create new CLIs (createCLI).
• Add commands to existing CLIs.
• Global flags:
  • --help to display instructions.
  • --version to check the DevPilot version.
  • --doc to display documentation.
• Automatic build for each created CLI.

Usage

1. Clone this repository:

git clone https://github.com/LucasPaulo001/DevPilot.git

2. Switch to the development branch

git checkout feature-devp/configs

3. In the project root, install dependencies

npm install

4. Build the project for better testing (built version is the best option for direct terminal tests)

npm run build

5. Now just run the index in the dist folder with:

npm start

Testing flags (global commands)

1. Run the project directly from dist using Node with the flags:

For help

node dist/cli/index.js --help

To check DevPilot version

node dist/cli/index.js --v

or

node dist/cli/index.js --version

To access documentation

node dist/cli/index.js --doc

Using DevPilot via NPM

1. Install DevPilot globally

npm install devpilot-core -g

2. Initialize DevPilot and create the base project for your CLI

devpilot

Global flags via npm:

1. Help

devpilot --help

2. Documentation

devpilot --doc

3. Version

devpilot --version

Creating My CLI

When generating a CLI, the following files will be created:

my-cli

• ├── src/
• | ├── dist/
• │ ├── cli/
• │ │ └── index.ts
• │ ├── commands/
• │ │ ├── hello.ts
• │ │ ├── ping.ts
• | └── devpilot.config.yaml
• ├── package.json
• └── tsconfig.json

index.ts is the entry point for creating the CLI command interface. This is where we will build the main questionnaire for commands.

The commands folder is where our commands will reside, meaning the automation we will build for the CLI.

---

Version 1.0.5 - 08/16/2025

Feature	Description
Flag Creation	Users can now generate flags easily through the interactive menu!
DevPilot Help Section	Updated help window with a new look
CLI Initialization Improvements	Dependencies are installed together with the CLI build, no extra installation needed