CLI - Interface de Linha de Comando

Todos os comandos disponíveis no velox com exemplos práticos.

Instalação

pip install velox-web

—

velox init — Cria um novo projeto

velox init meu-projeto

Saída:

✔   meu-projeto/app.py
✔   meu-projeto/.env
✔   meu-projeto/.gitignore
✔   meu-projeto/requirements.txt
✔   meu-projeto/templates/index.html
✔   meu-projeto/templates/404.html
✔   meu-projeto/static/css/style.css
✔   meu-projeto/static/img/velox-logo.png

✅ Projeto criado com sucesso!

  → cd meu-projeto
  → velox run

—

velox startapp — Cria um app modular

# App completo (com templates)
velox startapp blog

# App API-only (sem templates)
velox startapp api --api

# Sobrescreve se já existir
velox startapp blog --force

Saída (app completo):

✔   blog/__init__.py
✔   blog/models.py
✔   blog/views.py
✔   blog/admin.py
✔   blog/tests.py
✔   blog/templates/blog/list.html
✔   blog/templates/blog/form.html

App 'blog' criado!

  Adicione em app.py:
    from blog.views import router
    app.include(router)

—

velox run — Inicia o servidor

# Servidor padrão (localhost:8000)
velox run

# Porta customizada
velox run --port 5000

# Com auto-reload (recomendado em desenvolvimento)
velox run --reload

# Exposto na rede local
velox run --host 0.0.0.0 --port 8080

# Arquivo de app diferente
velox run minha_app.py --port 3000 --reload

Saída:

🌐 http://localhost:8000
↺ Auto-reload ativado
Ctrl+C para parar

—

velox routes — Lista as rotas registradas

velox routes

# Arquivo de app diferente
velox routes minha_app.py

Saída:

Rotas registradas:

GET       /
GET       /sobre
GET       /api/posts
POST      /api/posts
GET       /api/posts/<id>
PUT       /api/posts/<id>
DELETE    /api/posts/<id>
GET       /admin/
POST      /admin/login

Total: 9 rota(s)

—

velox create — Cria arquivos no projeto

# Criar um model
velox create model produto

# Criar uma view
velox create view home

# Criar um middleware
velox create middleware autenticacao

# Criar um template HTML
velox create template contato

Saída:

✔ Criado: models/produto.py
✔ Criado: views/home.py
✔ Criado: middlewares/autenticacao.py
✔ Criado: templates/contato.html

—

velox makemigration — Cria um arquivo de migration

velox makemigration create_posts
velox makemigration add_autor_to_posts
velox makemigration create_tags

Saída:

✔ Migration criada: migrations/20260329120000_create_posts.py
→ Edite o arquivo e rode: velox migrate

Arquivo gerado (migrations/20260329120000_create_posts.py):

"""
Migration: create_posts
Created: 2026-03-29 12:00:00
"""
from velox.migrations import Migration


class CreateMigration(Migration):
    def __init__(self):
        super().__init__("create_posts")

    def forward(self):
        self.create_table('posts', {
            'id':         'INTEGER PRIMARY KEY AUTOINCREMENT',
            'titulo':     'TEXT NOT NULL',
            'conteudo':   'TEXT',
            'criado_em':  'TIMESTAMP DEFAULT CURRENT_TIMESTAMP',
        })

    def backward(self):
        self.drop_table('posts')

—

velox migrate — Aplica as migrations pendentes

velox migrate

Saída (primeira vez):

✔ Aplicada: create_posts
✔ Aplicada: add_autor_to_posts
✔ Aplicada: create_tags

3 migration(s) aplicada(s).

Saída (já aplicadas):

  Já aplicada: create_posts
  Já aplicada: add_autor_to_posts
  Já aplicada: create_tags
→ Nenhuma migration pendente.

—

velox createuser — Cria um usuário admin

# Modo interativo (recomendado)
velox createuser

# Passando username e email diretamente
velox createuser --username joao --email joao@email.com

Saída (modo interativo):

Criar usuário admin

  Username: admin
  Email: admin@meusite.com
  Senha: ••••••••
  Confirmar senha: ••••••••

✔ Usuário 'admin' criado com sucesso!
→ Acesse /admin/ com suas credenciais.

—

velox version — Exibe a versão

velox version

Saída:

Velox Framework v1.0.0
Python 3.12.0

—

Fluxo completo — do zero ao projeto rodando

# 1. Criar projeto
velox init minha-loja
cd minha-loja

# 2. Criar apps
velox startapp produtos
velox startapp usuarios
velox startapp api --api

# 3. Criar migration e aplicar
velox makemigration create_produtos
# (edite o arquivo em migrations/)
velox migrate

# 4. Criar usuário admin
velox createuser

# 5. Rodar o servidor
velox run --reload

—

Rodar em produção

O Velox pode ser executado de várias formas:

Opção 1: Via app.run()

python app.py

Opção 2: Via uvicorn

uvicorn app:app –host localhost –port 8001 –reload

Opção 3: Via gunicorn (produção)

gunicorn app:app -w 4 -k uvicorn.workers.UvicornWorker –bind 0.0.0.0:8000

Opção 4: Via gunicorn com workers async

gunicorn app:app -w 2 -k uvicorn.workers.UvicornH11Worker –bind 0.0.0.0:8000

Opção 5: Via systemd (Linux/produção)

Crie um serviço em /etc/systemd/system/velox.service:

[Unit]
Description=Velox Application
After=network.target

[Service]
User=www-data
Group=www-data
WorkingDirectory=/var/www/meu-projeto
ExecStart=/var/www/meu-projeto/venv/bin/gunicorn app:app -w 4 -k uvicorn.workers.UvicornWorker --bind 0.0.0.0:8000
Restart=always

[Install]
WantedBy=multi-user.target

sudo systemctl enable velox
sudo systemctl start velox
Opção 6: Via Docker

Dockerfile:

FROM python:3.12-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt
COPY . .
CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "8000"]

docker build -t velox-app .
docker run -p 8000:8000 velox-app
Opção 7: Via Dockerfile-composer (multi-container)

docker-compose.yml:

version: '3.8'
services:
  app:
    build: .
    ports:
      - "8000:8000"
    environment:
      - DATABASE_URI=postgresql://user:pass@db:5432/myapp
      - CACHE_REDIS_URL=redis://cache:6379/0
  db:
    image: postgres:16
    environment:
      - POSTGRES_DB=myapp
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=pass
    volumes:
      - pgdata:/var/lib/postgresql/data
  cache:
    image: redis:7-alpine
volumes:
  pgdata:

docker-compose up -d

Resumo das opções:

—