Documentation

Documentation Draft

Tudo o que precisa para construir, publicar e operar com a CX Core.

Draft

Draft — esta documentação é um rascunho. Endpoints, comandos e exemplos são ilustrativos e podem mudar antes da versão final.

01 · v0.1 (draft)

Getting Started

Da conta ao primeiro deployment em poucos passos.

Este guia mostra como ligar o seu projeto à plataforma CX Core, configurar o acesso e publicar a primeira versão.

Crie uma conta no portal de cliente.
Gere uma chave de API para o seu projeto.
Instale a CLI e autentique-se.
Publique com um único comando.

Quickstart

cx login
cx init my-project
cx deploy

02 · v0.1 (draft)

API Reference

Endpoints REST para gerir projetos, servidores e serviços.

A API segue convenções REST, devolve JSON e é versionada no caminho do URL.

Method	Endpoint	Description
GET	/v1/projects	Lista os projetos da conta
POST	/v1/projects	Cria um novo projeto
GET	/v1/servers/{id}	Detalhe de um servidor
POST	/v1/deployments	Inicia um deployment

Example request

curl https://api.example.invalid/v1/projects \
  -H "Authorization: Bearer $CX_API_KEY"

O domínio da API é um marcador de posição até ao lançamento.

03 · v0.1 (draft)

Installation

Requisitos e instalação dos componentes CX Core.

Os componentes são distribuídos como imagens de contentor e como binário da CLI para Linux e macOS.

Linux (Debian 12+ ou Ubuntu 22.04+)
Docker 24+ e Docker Compose
Acesso de rede à porta 443

Docker

docker pull cxcore/agent:latest
docker run -d --name cx-agent cxcore/agent:latest

04 · v0.1 (draft)

Configuration

Ficheiro de configuração e variáveis de ambiente.

A configuração vive num ficheiro cx.config.yml na raiz do projeto. Valores sensíveis devem ser definidos por variáveis de ambiente.

cx.config.yml

project: my-project
region: eu-west
services:
  web:
    build: ./
    port: 3000
    healthcheck: /health

Variable	Description
CX_API_KEY	Chave de API do projeto
CX_REGION	Região por omissão
CX_LOG_LEVEL	debug, info, warn ou error

05 · v0.1 (draft)

Authentication

Chaves de API, tokens e controlo de acessos.

Todos os pedidos à API têm de incluir um token Bearer. As chaves têm âmbito por projeto e podem ser revogadas a qualquer momento.

Authorization header

Authorization: Bearer cx_live_xxxxxxxxxxxxxxxx

Nunca exponha chaves de API em código cliente ou em repositórios públicos.

06 · v0.1 (draft)

Webhooks

Receba eventos da plataforma em tempo real.

Os webhooks enviam um pedido POST assinado para o seu endpoint sempre que ocorre um evento, como um deployment concluído ou um alerta de monitorização.

Event	Triggered when
deployment.succeeded	Um deployment termina com sucesso
deployment.failed	Um deployment falha
alert.triggered	Um alerta de monitorização é disparado

Payload

{
  "event": "deployment.succeeded",
  "project": "my-project",
  "createdAt": "2026-01-01T12:00:00Z"
}

07 · v0.1 (draft)

CLI

Gerir projetos e infraestrutura a partir do terminal.

A CLI é a forma mais rápida de interagir com a plataforma e integra-se facilmente em pipelines de CI/CD.

Command	Description
cx login	Autentica a sessão
cx init	Inicializa um projeto
cx deploy	Publica a versão atual
cx logs	Mostra logs em tempo real

08 · v0.1 (draft)

Changelog

Histórico de alterações à plataforma e à documentação.

Entradas ilustrativas — o histórico real será publicado a partir do primeiro lançamento.

v0.1.0 — Estrutura inicial da documentação (draft).
v0.0.1 — Primeiro rascunho interno.