Revolte

https://docs.revolte.ai/
Admin
Revolte is an AI-powered platform designed to streamline the entire software development lifecycle,...
Tokens:22,998
Snippets:460
Trust Score:6.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize Prompt

Source: https://docs.revolte.ai/cli/quick-start

Start the CLI in the project directory to begin a task.

```bash
revolte --start
```

--------------------------------

### Reference revolte.yaml Configuration

Source: https://docs.revolte.ai/yaml/overview

A comprehensive example of a revolte.yaml file defining global configurations, environment-specific overrides, and service specifications.

```yaml
revolte:
  version: "1.0"
  project: Demo-Project
  appName: demo application
  # Global Configuration & AI Workflows
  config:
    codeReview:
      summarize: true
      suggestFixes: true
      commentStyle: Balanced
    codeQuality:
      codeStyle:
        rules:
          javascript/arrayCallbackReturn: warn
    testSuite:
      command: npm run test
    automationTestSuite:
      command: npm run test:automation
  workflow:
    developerWorkflow:
      enabled: true
  # Environment-specific Overrides
  env:
    production:
      branch: main
      codeReview: true
      codeQuality: true
      testSuite: true
      automationTestSuite: true
      services:
        rid_1:
          type: WEB_SERVICE
          name: web_service
          entryPoint: index.js
          properties:
            health: /health
            port: 8080
            loadBalancerMode: dedicated
            variables:
              BASE_URL: /api/v1
              JWT_TOKEN_SECRET: "#{JWT_TOKEN_SECRET}"
              SESSION_SECRET: "#{SESSION_SECRET}"
          insights:
            cpu:
              - cpu_time_idle
              - cpu_time_user
              - cpu_time_system
            swap:
              - swap_used
            mem:
              - mem_total
              - mem_free
            disk:
              - disk_used
              - disk_total
              - disk_free
          specifications:
            cpu: 2
            memory: 1
            storage: 30
            autoScaling:
              replica:
                min: 1
                max: 1
              utilization:
                cpu:
                  target: 70
                memory:
                  target: 70
              behavior:
                scaleDown:
                  stabilizationWindow: 300
    staging:
      branch: staging
      codeReview: true
      codeQuality: true
      testSuite: true
      automationTestSuite: true
      services:
        rid_1:
          type: WEB_SERVICE
          name: web_service
          entryPoint: index.js
          properties:
            health: /health
            port: 8080
            loadBalancerMode: dedicated
            variables:
              BASE_URL: /api/v1
          specifications:
            cpu: 2
            memory: 1
            storage: 30
    qa:
      branch: qa
      codeReview: true
      codeQuality: true
      testSuite: true
      automationTestSuite: true
      services:
        rid_1:
          type: WEB_SERVICE
          name: web_service
          entryPoint: index.js
          properties:
            health: /health
            port: 8080
            loadBalancerMode: shared
            variables:
              BASE_URL: /api/v1
          specifications:
            cpu: 2
            memory: 1
            storage: 30
    # Ephemeral Preview Environments
    preview:
      codeReview: true
      codeQuality: true
      testSuite: true
      automationTestSuite: true
      services:
        rid_1:
          type: WEB_SERVICE
          name: web_service
          entryPoint: index.js
          properties:
            health: /health
            port: 8080
            loadBalancerMode: dedicated
            variables:
              BASE_URL: /api/v1
          specifications:
            cpu: 2
            memory: 1
            storage: 30
```

--------------------------------

### Define Service Preset in YAML

Source: https://docs.revolte.ai/yaml/repo-preferences/preset-service

Example configuration for a production environment service mapping within the revolte.yaml file.

```yaml
revolte:
  env:
    production:
      branch: main
      services:
        rid_1:
          type: WEB_SERVICE
          name: api-service
```

--------------------------------

### Install Revolte CLI globally

Source: https://docs.revolte.ai/cli/reference

Installs the Revolte CLI package globally using npm. Requires Node.js version 20 or higher.

```bash
npm install -g @revolte.ai/cli
```

--------------------------------

### Authenticate CLI

Source: https://docs.revolte.ai/cli/quick-start

Connect the local environment to Revolte AI by opening a browser for secure authentication.

```bash
revolte --login
```

--------------------------------

### Configure environment pre-build settings

Source: https://docs.revolte.ai/yaml/environment-settings/pre-build

Define environment-specific automation flags within the revolte.yaml configuration file.

```yaml
revolte:
  version: "1.0"
  project: Sideline HQ
  appName: sideline-web-admin

  env:
    production:
      branch: main
      codeReview: true
      codeQuality: true
      testSuite: true
      automationTestSuite: true
```

--------------------------------

### Configure Pre-build Workflow in revolte.yaml

Source: https://docs.revolte.ai/yaml/repo-preferences/prebuild-workflow

Defines the project settings and enables automated code review features like summarization and fix suggestions.

```yaml
revolte:
  version: "1.0"
  project: Sideline HQ
  appName: sideline-web-admin

  config:
    codeReview:
      summarize: true
      suggestFixes: true
      commentStyle: Balanced
```

--------------------------------

### Configure Web App in revolte.yaml

Source: https://docs.revolte.ai/yaml/environment-settings/resource-specifications/web-app

Defines a static web application service within the environment configuration, including CDN settings and environment variables.

```yaml
revolte:
  version: "1.0"
  project: Demo-Project
  appName: "demo-app"
  workflow:
    developerWorkflow:
      enabled: true
  env:
    production:
      branch: main
      services:
        rid_1:
          type: WEB_APP
          name: web-app_service
          entryPoint: index.js
          properties:
            indexPage: index.html
            errorPage: index.html
            enableCdn: false
            variables:
              VITE_API_HOST: "#{beBaseURL}"
              VITE_GOOGLE_PLACES_API_KEY: "#{googlePlacesAPIKey}"
```

--------------------------------

### Missing services property error output

Source: https://docs.revolte.ai/yaml/repo-preferences/common-errors

Indicates that an environment has been defined but lacks a corresponding service configuration.

```text
Line 16  Missing property "services"
Line 20  Missing property "services"
Line 24  Missing property "services"
```

--------------------------------

### Configure Database Service in revolte.yaml

Source: https://docs.revolte.ai/deployments/services/databases/overview

Define database specifications including CPU, memory, storage, and engine type within the project configuration.

```yaml
revolte:
    version: '1.0'
    project: Demo-Project
    appName: demo-app
    env:
      production:
        branch: main
        services:
          rid_8:
            type: DATABASE
            name: db
            specifications:
              cpu: 2
              memory: 1
              storage: 30
              engine: postgres
```

--------------------------------

### Enable Code Quality in revolte.yaml

Source: https://docs.revolte.ai/yaml/repo-preferences/pipeline/code-quality

Configure the pipeline to run static analysis and security audits using a specified framework and strictness level.

```yaml
pipeline:
  codeQuality:
    enabled: true
    framework: "ESLint"
    level: "Strict"
    securityAudit: true
```

--------------------------------

### Define a WEB_SERVICE in revolte.yaml

Source: https://docs.revolte.ai/yaml/environment-settings/services

Configures a web service with a specific entry point, health check endpoint, and port mapping.

```yaml
env:
  production:
    services:
      rid_1:
        type: WEB_SERVICE
        name: api-service
        entryPoint: index.js
        properties:
          health: /health
          port: 8080
```

--------------------------------

### Define Storage Bucket in revolte.yaml

Source: https://docs.revolte.ai/deployments/services/object-storage/overview

Configures a storage bucket service with versioning, access control, and CORS rules.

```yaml
revolte:
    version: '1.0'
    project: Demo-Project
    appName: demo-app
    env:
      production:
        branch: main
        services:
          rid_2:
            type: STORAGE_BUCKET
            name: storage_bucket_service
            configurations:
              bucketName: demo-prod-bucket
              versioningStatus: enabled
              public: false
              corsRules:
                - methods:
                    - GET
                    - POST
                    - PUT
                    - DELETE
                  allowedHeaders:
                    - '*'
                  exposeHeaders:
                    - Etag
                  origins:
                    - '*'
```

--------------------------------

### Define environment-specific settings in revolte.yaml

Source: https://docs.revolte.ai/yaml/environment-settings/overview

Specify branch mappings for different deployment environments within the revolte.yaml configuration file.

```yaml
revolte:
  version: "1.0"
  project: Sideline HQ
  appName: sideline-web-admin
  env:
    production:
      branch: main
    staging:
      branch: staging
    qa:
      branch: qa
    preview:
      # Settings applied to ephemeral preview environments
      branch: "*"
```

--------------------------------

### Define Web Service Configuration in revolte.yaml

Source: https://docs.revolte.ai/deployments/services/web-services

Use this configuration to define web services, storage buckets, cache, and cron jobs. Ensure all environment variables and resource specifications are correctly mapped for your project requirements.

```yaml
revolte:
    version: '1.0'
    project: Demo-Project
    appName: demo-app
    config:
      codeReview:
        summarize: false
        suggestFixes: false
        commentStyle: Balanced
    workflow:
      developerWorkflow:
        enabled: true
    env:
      production:
        branch: main
        codeReview: false
        services:
          rid_1:
            type: WEB_SERVICE
            name: web_service
            entryPoint: index.js
            properties:
              health: /health
              port: 8080
              loadBalancerMode: dedicated
              variables:
                APPLICATION_PORT: '8080'
                APPLICATION_BASE_PATH: /api
                MAX_LOG_FILE_DAYS: '30'
                JWT_SECRET: '#{JWT_SECRET}'
                CACHE_HOST: '#{cache.cacheHost}'
                CACHE_PORT: '#{cache.cachePort}'
                CACHE_PASSWORD: '#{cache.cachePassword}'
                LOGIN_WEB_URL: https://app.demo.com/auth/login
                RESET_PASSWORD_WEB_URL: https://app.demo.com/auth/reset-password
            specifications:
              cpu: 2
              memory: 1
              storage: 30
              autoScaling:
                replica:
                  min: 1
                  max: 3
                utilization:
                  cpu:
                    target: 70
                  memory:
                    target: 70
                behavior:
                  scaleDown:
                    stabilizationWindow: 300
          rid_2:
            type: STORAGE_BUCKET
            name: storage_bucket_service
            configurations:
              bucketName: demo-prod-bucket
              versioningStatus: enabled
              public: false
              corsRules:
                - methods:
                    - GET
                    - POST
                    - PUT
                    - DELETE
                  allowedHeaders:
                    - '*'
                  exposeHeaders:
                    - Etag
                  origins:
                    - '*'
          rid_3:
            type: CACHE
            name: cache
            specifications:
              cpu: 2
              memory: 0.5
              replica: 1
          rid_5:
            type: CRON
            name: nightly_backup
            properties:
              schedule: "0 0 * * *"
              command: npm run backup
              variables:
                BUCKET_NAME: '#{storage_bucket_service.bucketName}'
```

--------------------------------

### Configure Web Application Service in YAML

Source: https://docs.revolte.ai/deployments/services/web-applications

Defines the project structure and service properties for a web application deployment. Ensure the entryPoint and indexPage are correctly specified for your application build.

```yaml
revolte:
    version: '1.0'
    project: Demo-Project
    appName: Demo-app
    env:
      production:
        branch: develop
        services:
          rid_1:
            type: WEB_APP
            name: web-app_service
            entryPoint: index.js
            properties:
              indexPage: index.html
              errorPage: error.html
              enableCdn: false
              variables:
                BASE_URL: /api/v1
```

--------------------------------

### Enable Developer Workflow in revolte.yaml

Source: https://docs.revolte.ai/yaml/repo-preferences/agent-workflow

Use this configuration to globally activate AI-assisted coding and debugging features.

```yaml
revolte:
  version: "1.0"
  project: Demo-Project
  appName: "demo-app"
  workflow:
    developerWorkflow:
      enabled: true # Activates AI-assisted coding and debugging
```

--------------------------------

### Configure Test Suite in revolte.yaml

Source: https://docs.revolte.ai/yaml/repo-preferences/pipeline/test-suite

Defines the test suite execution parameters including the command, Node.js version, and timeout duration.

```yaml
pipeline:
  testSuite:
    enabled: true
    command: "npm run test:ci"
    environment:
      node_version: "18"
    timeout: 300
```

--------------------------------

### Define Web Service in revolte.yaml

Source: https://docs.revolte.ai/yaml/environment-settings/resource-specifications/web-service

Configure service properties, monitoring insights, and resource specifications for a web service.

```yaml
revolte:
  version: "1.0"
  project: Demo-Project
  appName: "demo-app"

  env:
    production:
      branch: main
      services:
        rid_1:
          type: WEB_SERVICE
          name: web_service
          entryPoint: index.js
          properties:
            health: /health
            port: 8080
            loadBalancerMode: dedicated
            variables:
              JWT_TOKEN_SECRET: "#{JWT_TOKEN_SECRET}"
              JWT_TOKEN_EXPIRY: "#{JWT_TOKEN_EXPIRY}"

          insights:
            cpu:
              - cpu_time_idle
            swap:
              - swap_used
            mem:
              - mem_total
            disk:
              - disk_total
          specifications:
            cpu: 4
            memory: 16
            storage: 30
```

--------------------------------

### Enable Test Suite in revolte.yaml

Source: https://docs.revolte.ai/yaml/repo-preferences/pipelines/test-suite

Define the test suite configuration within the revolte.yaml file to specify the execution command.

```yaml
revolte:
  version: "1.0"
  project: Demo-Project
  appName: "demo-app"

  config:
    pipeline:
      testSuite:
        command: npm run test
```

--------------------------------

### Configure Auto-scaling for WEB_SERVICE

Source: https://docs.revolte.ai/yaml/environment-settings/resource-specifications/overview

Defines minimum and maximum replicas along with CPU and memory utilization targets for a production environment.

```yaml
revolte:
  version: "1.0"
  project: Demo-Project
  appName: "demo-app"
  env:
    production:
      branch: main
      services:
        rid_1:
          type: WEB_SERVICE
          specifications:
            autoScaling:
              replica: { min: 1, max: 5 }
              utilization:
                cpu: { target: 70 }
                memory: { target: 70 }
```
Tokens:
Raw