🚀 deploy-sftp

Um CLI para automação de deploy de projetos Vue.js via Git e SFTP.
Ele faz build, gerencia tags/branches e envia os arquivos para servidores de desenvolvimento e produção.

📋 Sumário

• 🚀 deploy-sftp
  • 📋 Sumário
  • 🔍 Recursos
  • ⚙️ Pré-requisitos
  • 📥 Instalação
  • 🔧 Configuração
  • 🚀 Uso
    • Via npx / NPX
    • Com pacote instalado globalmente
    • Como script no package.json
    • 🏳️ Flags disponíveis
    • 🛠️ Exemplos de uso
  • ⚙️ Fluxo de Deploy
  • 📄 Licença
  • 😁 Feito por Marcos Paulo

🔍 Recursos

• Menu interativo para escolher ambiente: todos, dev ou prod
• Build do projeto (yarn build ou npm run build)
• Git flow completo: clone em pasta temporária, commit, tag, push
• Upload de diretórios via SFTP com feedback em tempo real
• Suporte a flags:
  • -g, --git → apenas fluxo Git (inclui build)
  • -s, --sftp → apenas upload SFTP (inclui build)
  • -v, --version → exibe a versão instalada
  • -h, --help → exibe esta ajuda

⚙️ Pré-requisitos

• Node.js ≥ 14
• Yarn ou npm
• Acesso Git ao repositório remoto
• Acesso SFTP ao servidor de destino

📥 Instalação

Instale globalmente para usar o comando deploy-sftp ou o alias deploy de qualquer lugar:

npm install -g deploy-sftp
# ou
yarn global add deploy-sftp

Isso cria dois comandos no seu PATH:

• deploy-sftp
• deploy

Ou adicione como dependência de desenvolvimento no seu projeto:

npm install --save-dev deploy-sftp
# ou
yarn add --dev deploy-sftp

Todas as dependências (dotenv, ssh2-sftp-client, yargs, inquirer, ora) são instaladas automaticamente.

🔧 Configuração

1. Na raiz do seu projeto Vue, crie um arquivo .env com as variáveis abaixo.
2. Ajuste valores de URL do repositório, credenciais Git e SFTP.

# Repositório Git
VITE_REPO_URL=https://github.com/usuario/projeto.git
[email protected]
VITE_GIT_USER=Seu Nome

# Build
VITE_BUILD_FOLDER=dist

# Ambiente DEV
VITE_FTP_HOST_DEV=dev.exemplo.com
VITE_FTP_PORT_DEV=22
VITE_FTP_USER_DEV=usuario_dev
VITE_FTP_PASS_DEV=senha_dev
VITE_FTP_DIRR_DEV=/var/www/dev

# Ambiente PROD
VITE_FTP_HOST_PROD=prod.exemplo.com
VITE_FTP_PORT_PROD=22
VITE_FTP_USER_PROD=usuario_prod
VITE_FTP_PASS_PROD=senha_prod
VITE_FTP_DIRR_PROD=/var/www/prod

Importante:

• VITE_BUILD_FOLDER deve ser o diretório gerado pelo yarn build.
• VITE_REPO_URL pode ser HTTPS ou SSH. Se for Bitbucket HTTPS, o script converterá para SSH automaticamente.

🚀 Uso

Via npx / NPX

npx deploy-sftp
# ou
npx deploy

Com pacote instalado globalmente

deploy-sftp
# ou
deploy

Como script no package.json

Adicione em "scripts":

{
  "scripts": {
    "deploy": "deploy-sftp",
    // ou
    "deploy": "deploy"
  }
}

E então:

npm run deploy
# ou
yarn deploy

🏳️ Flags disponíveis

• -g, --git → somente fluxo Git (build + gitFlow)
• -s, --sftp → somente upload SFTP (build + sftpUpload)
• -v, --version → exibe a versão do CLI
• -h, --help → exibe esta ajuda

🛠️ Exemplos de uso

# deploy completo (build + gitFlow + sftpUpload)
deploy

# apenas Git flow
deploy -g
# ou
deploy --git

# apenas SFTP
deploy -s
# ou
deploy --sftp

# ver versão
deploy -v

# ver ajuda
deploy -h

⚙️ Fluxo de Deploy

1. Menu interativo para escolher ambiente: todos, dev ou prod.
2. Executa build do Vue (yarn build).
3. Clona branch alvo em pasta temporária.
4. Substitui conteúdo por build atual.
5. Configura Git (usuário/email).
6. Seleciona ou cria nova tag.
7. Commit + tag + push para repositório remoto.
8. Realiza upload dos arquivos build via SFTP.
9. Remove pasta temporária e encerra.

📄 Licença

Unlicense

😁 Feito por Marcos Paulo

https://marcospaulo.dev