Prabogo Documentation

Getting Started

Prabogo is a Go framework designed to simplify project development by providing an interactive command interface and built-in instructions for AI assistance. This framework streamlines common engineering tasks, making it easier for software engineers to scaffold, generate, and manage project components efficiently.

Requirements

• Go version >= 1.24.0
• Docker and Docker Compose (optional, for running external services)
• fzf (optional, for enhanced interactive command selection)

Installation

# Install the CLI tool
go install github.com/prabogo/prabogo-cli@latest

# Create a new project
prabogo-cli install my-project-name

After the cloning is complete, you will be prompted to select your preferred stack. Choose the components you want to include in your project:

# Setup the project
cd my-project-name
cp .env.example .env
cp .env.docker.example .env.docker
go mod tidy
docker-compose --env-file .env.docker up -d

Running the Application

You have several options to run your Prabogo application:

# Using the interactive command selector
prabogo-cli run

# Running in HTTP server mode
prabogo-cli http

# Running in message consumer mode
prabogo-cli message upsert_client

# Executing a specific command
prabogo-cli command publish_upsert_client name

# Running directly without CLI
go run cmd/main.go http

Architecture

Prabogo uses Hexagonal Architecture (also known as Ports and Adapters pattern) to keep the business logic separate from external dependencies like databases, UI frameworks, and messaging systems.

Key Components

• Port: Interface defining how the application communicates with the outside world.
• Adapter: Component implementing a port to connect external systems or technologies to the core.
• Domain: Core business logic and rules, independent of external systems or frameworks.
• Application: Layer that coordinates activities and orchestrates domain logic.

This architecture allows you to:

• Replace infrastructure components with minimal changes
• Test business logic in isolation
• Develop features without being constrained by external dependencies
• Maintain a clean separation of concerns

Read more about Prabogo's architecture

Authorization

Prabogo supports multiple authorization strategies to secure your applications. You can choose between internal bearer key authentication or integrate with external identity providers like Authentik for enhanced security.

Configuration Overview

Authorization is configured through the AUTH_DRIVER environment variable. Prabogo supports two main authorization methods:

1. Internal Bearer Key Authentication

This method uses internal client bearer keys stored in your database. While simple to implement, it's recommended to use mTLS (mutual TLS) when using this approach for enhanced security.

Configuration

# Set AUTH_DRIVER to empty/blank for internal authentication
AUTH_DRIVER=

# Other required configurations
DATABASE_USERNAME=prabogo
DATABASE_PASSWORD=prabogo
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_NAME=prabogo

Security Recommendations

Benefits of using mTLS with internal authentication:

• Mutual authentication between client and server
• Certificate-based identity verification
• Protection against man-in-the-middle attacks
• Enhanced encryption for data in transit

2. Authentik JWT Authentication (Recommended)

For enhanced security, Prabogo integrates with Authentik using JWT (JSON Web Token) client credentials flow. This method provides enterprise-grade authentication and authorization capabilities.

Configuration

# Set AUTH_DRIVER to "authentik" for JWT authentication
AUTH_DRIVER=authentik

# Configure the JWKS URL for token validation
AUTH_JWKS_URL=https://your-authentik-server.com/application/o/your-app/jwks/

# Example configuration
# AUTH_JWKS_URL=https://authentik-server.prabogo.orb.local/application/o/prabogo/jwks/

Authentik Setup Requirements

To use Authentik JWT authentication, you need to:

1. Run Authentik Server (Development)

   For development and testing purposes, you can run Authentik locally using the provided Docker Compose file:

   Copy

   # Start Authentik services (PostgreSQL, Redis, Server, Worker)
   docker-compose -f docker-compose.authentik.yml up -d
   
   # Check if all services are running
   docker-compose -f docker-compose.authentik.yml ps
   
   # Access Authentik web interface
   # Navigate to: http://localhost:9080

   Default Access:

   • HTTP: http://localhost:9080
   • Initial Setup: http://localhost:9080/if/flow/initial-setup
   💡 Development Note: The docker-compose.authentik.yml file includes all necessary services (PostgreSQL on port 5433, Redis on port 6380, and Authentik server). Make sure these ports are available on your system.
2. Create an Application in Authentik
   • Configure OAuth2/OpenID provider
   • Configure Application
   • Configure appropriate scopes and permissions (necessary)
3. Create Service Account (Recommended)
   • Create a user with service account type in Authentik
   • Generate an app password for the service account
   • Use username/password authentication to obtain JWT tokens
   • This approach provides better security and token management compared to client credentials

   Once you have created a service account and app password, you can obtain JWT tokens using a curl request:

   Copy

   curl --location 'https://your-authentik-server.com/application/o/token/' \
   --header 'Content-Type: application/x-www-form-urlencoded' \
   --data-urlencode 'grant_type=client_credentials' \
   --data-urlencode 'client_id=your-client-id' \
   --data-urlencode 'scope=openid' \
   --data-urlencode 'username=your-service-account' \
   --data-urlencode 'password=your-generated-app-password'

   Response: The API will return a JSON response containing the access_token (JWT) and other token information:

   Copy

   {
     "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE2NzM...",
     "token_type": "Bearer",
     "expires_in": 300,
     "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE2NzM..."
   }

4. Configure JWKS Endpoint
   • Obtain the JWKS URL from your Authentik application
   • Ensure the endpoint is accessible from your Prabogo application
5. Set Environment Variables
   • Update AUTH_DRIVER=authentik
   • Set the correct AUTH_JWKS_URL

Benefits of Authentik JWT Authentication

• Enhanced Security: Industry-standard JWT tokens with digital signatures
• Centralized Identity Management: Single sign-on (SSO) capabilities
• Scalability: Stateless authentication suitable for microservices
• Token Validation: Automatic token validation using JWKS
• Fine-grained Access Control: Role-based and attribute-based access control
• Audit Trail: Comprehensive logging of authentication events

Choosing the Right Method

Migration Between Methods

You can easily switch between authentication methods by updating the environment variables:

# Switch to internal authentication
AUTH_DRIVER=
# Remove or comment out AUTH_JWKS_URL

# Switch to Authentik authentication
AUTH_DRIVER=authentik
AUTH_JWKS_URL=https://your-authentik-server.com/application/o/your-app/jwks/

After changing the configuration, restart your application to apply the new authentication method.

CLI Commands

Prabogo provides a comprehensive CLI with various helpful commands for code generation and development tasks.

Interactive Command Runner

You can use the interactive target selector to choose and run targets:

prabogo-cli run

Code Generation Commands

• prabogo-cli model name

  Creates a model/entity with necessary structures

• prabogo-cli migration-postgres name

  Creates a PostgreSQL migration file

• prabogo-cli inbound-http-fiber name

  Creates HTTP handlers using Fiber framework

• prabogo-cli inbound-message-rabbitmq name

  Creates RabbitMQ message consumers

• prabogo-cli inbound-command name

  Creates command line interface handlers

• prabogo-cli inbound-workflow-temporal name

  Creates Temporal workflow worker

• prabogo-cli outbound-database-postgres name

  Creates PostgreSQL database adapter

• prabogo-cli outbound-http name

  Creates HTTP adapter

• prabogo-cli outbound-message-rabbitmq name

  Creates RabbitMQ message publisher adapter

• prabogo-cli outbound-cache-redis name

  Creates Redis cache adapter

• prabogo-cli outbound-workflow-temporal name

  Creates Temporal workflow starter adapter

• prabogo-cli generate-mocks

  Generates mock implementations from all go:generate directives in registry files

Runtime Commands

• prabogo-cli build

  Builds the Docker image for the application

• prabogo-cli http

  Runs the application in HTTP server mode inside Docker

• prabogo-cli message upsert_client

  Runs the application in message consumer mode inside Docker

• prabogo-cli command publish_upsert_client name

  Executes a specific command in the application

• prabogo-cli workflow upsert_client

  Runs the application in workflow worker mode inside Docker

Development Workflow

A typical development workflow in a Prabogo project follows these steps:

1. Create Models

   Define your domain models that represent your business entities:

   Copy

   prabogo-cli model product

2. Create Database Migrations

   Define database schema for your models:

   Copy

   prabogo-cli migration-postgres product

3. Implement Domain Logic

   Add your business logic in the domain layer, focusing on the core functionality without external dependencies.

4. Create Inbound Adapters

   Create adapters for handling incoming requests:

   Copy

   # For HTTP endpoints
   prabogo-cli inbound-http-fiber product
   
   # For message consumers
   prabogo-cli inbound-message-rabbitmq product
   
   # For CLI commands
   prabogo-cli inbound-command product
   
   # For Temporal workflows
   prabogo-cli inbound-workflow-temporal product

5. Create Outbound Adapters

   Create adapters for external dependencies:

   Copy

   # For database access
   prabogo-cli outbound-database-postgres product
   
   # For HTTP clients
   prabogo-cli outbound-http product_api
   
   # For cache
   prabogo-cli outbound-cache-redis product
   
   # For Temporal workflows
   prabogo-cli outbound-workflow-temporal product

6. Write Tests

   Write tests for your domain logic and generate mocks for your ports:

   Copy

   prabogo-cli generate-mocks

7. Run the Application

   Start your application in the appropriate mode:

   Copy

   # Start your application in the appropriate mode:
   prabogo-cli http
   
   # Or run in workflow worker mode
   prabogo-cli workflow product_workflow

Code Generation

Prabogo provides powerful code generation capabilities to streamline development. When you use the CLI commands to generate code, Prabogo creates:

• Appropriate interfaces (ports) in the port directory
• Implementation files in the adapter directory
• Necessary registrations in registry files
• Tests and mocks as needed

This ensures consistency across your codebase and reduces the boilerplate code you need to write.

Testing

Prabogo promotes writing unit tests for your domain logic. The hexagonal architecture makes it easy to test your business logic in isolation by mocking external dependencies.

Running Tests

# Run unit tests
go test -cover ./internal/domain/...

# Generate coverage report
go test -coverprofile=coverage.profile -cover ./internal/domain/...
go tool cover -html coverage.profile -o coverage.html

# Check for intermittent test failures
retry -d 0 -t 100 -u fail -- go test -coverprofile=coverage.profile -cover ./internal/domain/... -count=1

Deployment

Prabogo projects come with Docker support out of the box, making deployment straightforward:

Building a Docker Image

prabogo-cli build

Deployment Options

You can deploy your Prabogo application in various ways:

• Docker Compose: Ideal for development and simple deployments
• Kubernetes: For container orchestration in production
• Cloud Platforms: Deploy to AWS, GCP, or Azure with their respective container services

AI Agent Workflow

Prabogo now uses Spec Kit to support spec-driven development with AI agents. The project provides a structured workflow for defining principles, writing specs, planning work, generating tasks, and implementing changes with your preferred supported AI agent.

Spec Kit Integration

Spec Kit is initialized in this repository and currently configured for GitHub Copilot by default. It adds project files under .specify/ and agent integration files under .github/ so development can follow a clear, repeatable workflow.

With Spec Kit, you can guide AI-assisted development through these generated commands:

/speckit.constitution
/speckit.specify
/speckit.plan
/speckit.tasks
/speckit.implement

For a concrete end-to-end example, see the Spec Kit detailed example: Building Taskify.

This workflow helps teams:

• Define requirements before implementation starts
• Break features into explicit plans and tasks
• Keep AI-assisted development aligned with project architecture
• Use the same process across different supported AI tools

Installing Specify CLI

Spec Kit requires Python 3.11 or newer and assumes uv is already installed.

uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@v0.8.4
specify version

Reinitialize Spec Kit

If you need to refresh the generated Spec Kit files in your project, run:

specify init . --integration copilot

You can also switch to another supported AI integration when needed:

specify integration list

# Example: switch integration
specify init . --force --integration claude

Entire.io Checkpoints

Prabogo also recommends Entire.io to capture context from AI agent-assisted development. Entire records prompts, decisions, and iterations on a separate Git branch so you can preserve session context without cluttering the main project history.

Entire is useful when you want to:

• Capture full development context alongside code changes
• Help teammates understand why a change was made
• Resume interrupted AI sessions more easily
• Keep checkpoint history separate from your main commit history

Quick start:

entire enable

To inspect captured sessions and explanations later:

entire sessions list
entire explain -c <checkpoint-id>

Best Practices

Project Structure

Follow the provided directory structure to maintain a clean organization:

• cmd/: Application entry points
• internal/: Application code not meant to be imported by other projects
  • domain/: Core business logic and rules
  • port/: Interfaces defining how the application communicates
  • adapter/: Implementations of the ports connecting to external systems
  • model/: Data structures and entities
  • migration/: Database migration scripts
• utils/: Utility functions and helpers
• tests/: Test helpers and mocks

Domain-Driven Design

Prabogo works well with DDD principles:

• Keep business logic in the domain layer
• Use domain models to represent business entities
• Define clear boundaries between different domains
• Use domain events for communication between domains

Testing

• Write unit tests for all domain logic
• Use mocks for external dependencies
• Aim for high test coverage of domain code
• Consider integration tests for adapter implementations