### Install dependencies and run local preview

Source: https://github.com/ravionhq/docs/blob/main/README.md

Commands to prepare the development environment and start the local documentation server.

```bash
npm install
```

```bash
npm run dev
```

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

### Install Mintlify skill

Source: https://github.com/ravionhq/docs/blob/main/AGENTS.md

Use this command to install the Mintlify skill for product knowledge and configuration assistance.

```bash
npx skills add https://mintlify.com/docs
```

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

### Install Ravion CLI

Source: https://github.com/ravionhq/docs/blob/main/start-here.mdx

Install the CLI via Homebrew or the provided install script.

```bash
brew install ravionhq/tap/ravion
```

```bash
curl -fsSL https://github.com/ravionhq/cli/releases/latest/download/install.sh | sh
```

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

### Install Ravion Docs MCP server

Source: https://github.com/ravionhq/docs/blob/main/agent-skill.mdx

Installs the MCP server to allow the agent to search documentation. Requires an agent restart to make tools available.

```bash
npx add-mcp https://www.ravion.com/docs/mcp --name ravion-docs
```

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

### Verify installation

Source: https://github.com/ravionhq/docs/blob/main/cli/installation.mdx

Checks that the CLI is correctly installed and accessible in the system PATH.

```bash
ravion --version
```

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

### Install via shell script

Source: https://github.com/ravionhq/docs/blob/main/cli/installation.mdx

Downloads and installs the latest Ravion CLI binary to /usr/local/bin.

```bash
curl -fsSL https://github.com/ravionhq/cli/releases/latest/download/install.sh | sh
```

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

### Example Plan Output

Source: https://github.com/ravionhq/docs/blob/main/migrate/import-into-standard-module.mdx

Sample output showing resource addresses that require importing.

```text
ADDRESS                                                                 CHANGE_TYPE
aws_db_instance.this                                                    CREATE
aws_db_parameter_group.this[0]                                          CREATE
aws_db_subnet_group.this                                                CREATE
module.security_group[0].aws_security_group.this                        CREATE
module.security_group[0].aws_vpc_security_group_egress_rule.this["0"]   CREATE
```

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

### Configure parallel build and test with sequential deploy

Source: https://github.com/ravionhq/docs/blob/main/pipelines/examples.mdx

Runs a build and a custom test step in parallel, followed by a sequential deployment. The custom step requires setup actions to install dependencies on the provisioned infrastructure.

```yaml
inputs:
  - id: branch
    type: string
    default: main
variants:
  - id: production
    name: Production
steps:
  - parallel:
      - id: build_web_app
        name: Build web-app
        type: build
        module_instance: << pipeline.variant.id >>.web-app
        input:
          branch: << pipeline.input.branch >>
      - id: run_tests
        name: Run tests
        type: custom
        source:
          type: git
          repo: https://github.com/my-org/my-repo
          branch: << pipeline.input.branch >>
        setup:
          - uses: node
            with:
              node-version: "22"
        commands:
          - npm ci
          - npm test
        infrastructure:
          type: ec2
          instance_size: t3.medium
          aws_account_id: awsacct_123
          region: us-east-1
  - id: deploy_web_app
    name: Deploy web-app
    type: deploy
    module_instance: << pipeline.variant.id >>.web-app
    input:
      image_ref: << steps.build_web_app.output.image_digest >>
```

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

### Install via Homebrew

Source: https://github.com/ravionhq/docs/blob/main/cli/installation.mdx

Installs the Ravion CLI on macOS using the Homebrew package manager.

```bash
brew install ravionhq/tap/ravion
```

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

### Install specific version to custom directory

Source: https://github.com/ravionhq/docs/blob/main/cli/installation.mdx

Uses environment variables to specify a version and installation path during the script execution.

```bash
RAVION_VERSION=0.2.0 RAVION_INSTALL_DIR="$HOME/bin" \
  sh -c "$(curl -fsSL https://github.com/ravionhq/cli/releases/latest/download/install.sh)"
```

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

### Configure package.json scripts

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/tanstack-start.mdx

Define the build and start scripts required for the TanStack Start application to run in the production environment.

```json
{
  "scripts": {
    "build": "vite build && tsc --noEmit",
    "start": "node .output/server/index.mjs"
  }
}
```

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

### Deploy project via agent

Source: https://github.com/ravionhq/docs/blob/main/start-here.mdx

Provide this instruction to your agent to initiate the automated installation, configuration, and deployment process.

```text
Deploy this project to AWS with Ravion.
```

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

### Create and apply project configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/vue.mdx

Commands to initialize the project and apply the configuration file to the Ravion environment.

```bash
ravion project create --given-id vue-site --name "Vue site"
ravion project config apply vue-site --file ravion.yaml --dry-run
ravion project config apply vue-site --file ravion.yaml
```

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

### Create a new project configuration

Source: https://github.com/ravionhq/docs/blob/main/config-as-code/project-config-file.mdx

Initializes a new project and generates a draft configuration file.

```bash
ravion project create --given-id <project-id> --name "My project" --file ravion.yaml
```

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

### ravion domain get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/domain.mdx

Get details for a specific domain by ID.

```APIDOC
## ravion domain get

### Description
Get details for a specific domain by ID.

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the domain

#### Flags
- **--json** (boolean) - Optional - emit response as JSON
```

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

### Deploy Bun project via CLI

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/bun.mdx

Create the project and apply the configuration using the Ravion CLI.

```bash
ravion project create --given-id bun-app --name "Bun app"
ravion project config apply bun-app --file ravion.yaml --dry-run
ravion project config apply bun-app --file ravion.yaml
```

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

### Apply project configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/solid.mdx

Commands to create the project and apply the configuration to the environment.

```bash
ravion project create --given-id solid-site --name "Solid site"
ravion project config apply solid-site --file ravion.yaml --dry-run
ravion project config apply solid-site --file ravion.yaml
```

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

### Create and configure a Laravel project

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/laravel.mdx

Use these commands to initialize a new project and apply configuration settings from a YAML file.

```bash
ravion project create --given-id laravel-app --name "Laravel app"
ravion project config apply laravel-app --file ravion.yaml --dry-run
ravion project config apply laravel-app --file ravion.yaml
```

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

### Standby Validation URL Example

Source: https://github.com/ravionhq/docs/blob/main/module-definitions/catalog/rvn-ecs-web.mdx

Example URL for validating standby traffic using the default query parameter.

```text
https://app.example.com/health?__x-rvn-test__=1
```

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

### Apply Backstage project configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/backstage.mdx

Commands to create the project and apply the configuration file to the Ravion environment.

```bash
ravion project create --given-id backstage-app --name "Backstage app"
ravion project config apply backstage-app --file ravion.yaml --dry-run
ravion project config apply backstage-app --file ravion.yaml
```

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

### Apply deployment configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/django.mdx

Commands to create the project and apply the configuration file to the environment.

```bash
ravion project create --given-id django-app --name "Django app"
ravion project config apply django-app --file ravion.yaml --dry-run
ravion project config apply django-app --file ravion.yaml
```

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

### Apply project configuration via CLI

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/angular.mdx

Commands to create the project and apply the configuration file to the Ravion environment.

```bash
ravion project create --given-id angular-site --name "Angular site"
ravion project config apply angular-site --file ravion.yaml --dry-run
ravion project config apply angular-site --file ravion.yaml
```

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

### Create a deployment

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/deploy.mdx

Initiates a new deployment for a specific module instance.

```bash
ravion deploy create [flags]
```

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

### Get Environment

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/environment.mdx

Retrieves details for a specific environment by ID.

```bash
ravion environment get <id> [flags]
```

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

### Apply deployment configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/redwood.mdx

Commands to initialize the project and apply the configuration file to the Ravion environment.

```bash
ravion project create --given-id redwood-app --name "RedwoodJS app"
ravion project config apply redwood-app --file ravion.yaml --dry-run
ravion project config apply redwood-app --file ravion.yaml
```

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

### Get domain details

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/domain.mdx

Retrieve information about a domain by its ID.

```bash
ravion domain get <id> [flags]
```

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

### Rollback a deployment

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/deploy.mdx

Starts a rollback process for a given deployment.

```bash
ravion deploy rollback <id> [flags]
```

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

### Get a pipeline version

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/pipeline.mdx

Retrieves details for a specific PipelineVersion by its ID.

```bash
ravion pipeline version get <id> [flags]
```

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

### ravion module version get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/module.mdx

Retrieves a module version by its ID.

```APIDOC
## ravion module version get <id>

### Description
Get ModuleVersion by id.

### Usage
`ravion module version get <id> [flags]`

### Flags
- **--json** - Emit response as JSON.
```

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

### Sign up for a new Ravion account

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/signup.mdx

Executes the signup process using the Ravion CLI.

```bash
ravion signup [flags]
```

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

### Apply deployment configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/tanstack-start.mdx

Use the Ravion CLI to create the project and apply the infrastructure configuration to the AWS environment.

```bash
ravion project create --given-id tanstack-start-app --name "TanStack Start app"
ravion project config apply tanstack-start-app --file ravion.yaml --dry-run
ravion project config apply tanstack-start-app --file ravion.yaml
```

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

### Get ModuleInstance

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/module.mdx

Command to retrieve details of a module instance by its ID.

```bash
ravion module get <id> [flags]
```

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

### Get ModuleDefinition

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/module.mdx

Command to retrieve details of a module definition by its ID.

```bash
ravion module definition get <id> [flags]
```

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

### Apply Project Configuration

Source: https://github.com/ravionhq/docs/blob/main/migrate/import-into-standard-module.mdx

Apply the refined configuration to verify the imported resources.

```bash
ravion project config apply <project-id> --file ravion.yaml
```

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

### ravion user get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/user.mdx

Retrieves authentication settings for a specific user.

```APIDOC
## ravion user get

### Description
Get auth settings for a user.

### Usage
`ravion user get <userId> [flags]`

### Flags
- **--json** (boolean) - Optional - emit response as JSON
```

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

### Create a new project

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/project.mdx

Creates a project with a unique given ID and name.

```bash
ravion project create [flags]
```

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

### ravion stack get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/stack.mdx

Retrieves details for a specific stack by its ID.

```APIDOC
## ravion stack get <id>

### Description
Get Stack by id.

### Parameters
- **id** (string) - Required - The unique identifier of the stack.
- **--json** (flag) - Optional - Emit response as JSON.
```

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

### Create a module version

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/module.mdx

Creates a new module version with required configuration, description, definition ID, and semantic version.

```bash
ravion module version create [flags]
```

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

### Configure build:image step

Source: https://github.com/ravionhq/docs/blob/main/pipelines/step-types.mdx

Builds a Docker image from a git source and pushes it to ECR. Requires an infrastructure block to define the execution environment.

```yaml
- id: build_image
  name: Build image
  type: build:image
  source:
    type: git
    repo: https://github.com/my-org/my-repo
    branch: main
  builder:
    type: dockerfile
  destinations:
    - id: ecr
      type: ecr
      repository_arn: arn:aws:ecr:us-east-1:123456789012:repository/my-app
      tags:
        - << pipeline.input.commit >>
  infrastructure:
    type: ec2
    instance_size: medium
```

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

### ravion service-account get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/service-account.mdx

Retrieves details for a specific service account.

```APIDOC
## ravion service-account get

### Description
Fetches the details of a service account by its unique ID.

### Usage
`ravion service-account get <id> [flags]`

### Flags
- **--json** (boolean) - Optional - Emit response as JSON.
```

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

### Get project details

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/project.mdx

Retrieves information about a specific project by its ID.

```bash
ravion project get <id> [flags]
```

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

### ravion membership get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/membership.mdx

Retrieves details for a specific membership by ID.

```APIDOC
## ravion membership get

### Description
Get membership by ID.

### Usage
`ravion membership get <id> [flags]`

### Flags
- **--json** - Optional - Emit response as JSON
```

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

### List Environments

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/environment.mdx

Lists all environments.

```bash
ravion environment list [flags]
```

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

### ravion organization get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/organization.mdx

Retrieves details for a specific organization by ID.

```APIDOC
## ravion organization get

### Description
Fetches information for a specific organization using its unique identifier.

### Parameters
#### Path Parameters
- **id** (string) - Required - The organization ID

#### Flags
- **--json** (boolean) - Optional - emit response as JSON
```

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

### Apply project configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/nuxt.mdx

Commands to create the project and apply the configuration to the AWS environment.

```bash
ravion project create --given-id nuxt-app --name "Nuxt app"
ravion project config apply nuxt-app --file ravion.yaml --dry-run
ravion project config apply nuxt-app --file ravion.yaml
```

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

### Get organization details

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/organization.mdx

Retrieves information for a specific organization by its ID.

```bash
ravion organization get <id> [flags]
```

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

### ravion deploy get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/deploy.mdx

Retrieves details for a specific deployment by ID.

```APIDOC
## ravion deploy get

### Description
Get Deployment by id.

### Usage
`ravion deploy get <id> [flags]`

### Flags
- **--json** - Optional - emit response as JSON
```

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

### Create a CodeSource

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/code-source.mdx

Initializes a new code source using required Git provider configuration flags.

```bash
ravion code-source create [flags]
```

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

### Apply deployment configuration via CLI

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/docusaurus.mdx

Commands to initialize the project and apply the configuration to the AWS environment.

```bash
ravion project create --given-id docusaurus-site --name "Docusaurus site"
ravion project config apply docusaurus-site --file ravion.yaml --dry-run
ravion project config apply docusaurus-site --file ravion.yaml
```

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

### ravion api-key get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/api-key.mdx

Retrieves details for a specific API key.

```APIDOC
## ravion api-key get

### Description
Get details for a specific API key by its ID.

### Usage
`ravion api-key get <id> [flags]`

### Flags
- **--json** - Emit response as JSON
```

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

### GET /stacks/{id}/lock

Source: https://github.com/ravionhq/docs/blob/main/troubleshooting/stuck-terraform-state-lock.mdx

Retrieves the current lock status for a stack.

```APIDOC
## GET /stacks/{id}/lock

### Description
Returns the current lock information for the specified stack without modifying it.

### Method
GET

### Endpoint
/stacks/{id}/lock

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the stack.
```

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

### List projects

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/project.mdx

Lists all projects, with options for pagination and verbose output.

```bash
ravion project list [flags]
```

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

### Apply Ravion project configuration

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/strapi.mdx

Commands to create the project and apply the configuration to the AWS environment.

```bash
ravion project create --given-id strapi-app --name "Strapi app"
ravion project config apply strapi-app --file ravion.yaml --dry-run
ravion project config apply strapi-app --file ravion.yaml
```

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

### Get a pipeline step execution

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/pipeline.mdx

Retrieves details for a specific PipelineStepExecution by its ID.

```bash
ravion pipeline step-execution get <id> [flags]
```

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

### Create a domain

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/domain.mdx

Create a new domain using JSON data.

```bash
ravion domain create [flags]
```

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

### Get pipeline details

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/pipeline.mdx

Retrieves information about a specific pipeline using its ID.

```bash
ravion pipeline get <id> [flags]
```

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

### Get Terraform Resource

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/terraform.mdx

Retrieves details for a specific Terraform resource by ID.

```bash
ravion terraform resource get <id> [flags]
```

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

### Apply Project Configuration

Source: https://github.com/ravionhq/docs/blob/main/guides/custom-domains.mdx

Execute the stack pipeline to apply the certificate configuration changes.

```bash
ravion project config apply <project-id> --file ravion.yaml --autoapprove
```

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

### Get Terraform Execution Summary

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/terraform.mdx

Retrieves a specific execution summary by ID.

```bash
ravion terraform execution-summary get <id> [flags]
```

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

### Print project configuration schema

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/project.mdx

Displays the schema for the project configuration file.

```bash
ravion project config schema
```

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

### Get a module version

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/module.mdx

Retrieves details for a specific module version by its ID.

```bash
ravion module version get <id> [flags]
```

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

### List ModuleInstances

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/module.mdx

Command to list all module instances.

```bash
ravion module list [flags]
```

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

### Get stack details

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/stack.mdx

Retrieve information about a specific stack using its ID.

```bash
ravion stack get <id> [flags]
```

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

### Custom Laravel Startup Commands

Source: https://github.com/ravionhq/docs/blob/main/deploy/aws/laravel.mdx

Use these commands as part of a custom startup process to ensure the application is correctly configured for production.

```bash
php artisan migrate --force
php artisan storage:link
php artisan optimize
```

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

### Get Environment Module Graph

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/environment.mdx

Retrieves the module graph for a specific environment.

```bash
ravion environment module-graph <id> [flags]
```

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

### List deployment resources

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/deploy.mdx

Lists resources associated with deployments.

```bash
ravion deploy resource list [flags]
```

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

### CLI Import Commands

Source: https://github.com/ravionhq/docs/blob/main/migrate/import-into-terraform-stack.mdx

Commands to initialize the environment and import resources into a specific workspace.

```bash
ravion terraform shell --workspace <workspace> -- tofu init
```

```bash
... -- tofu import <address> <id>
```

```bash
ravion stack get <stack-id> --json
```

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

### Get Execution Environment

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/environment.mdx

Retrieves details for a specific execution environment by ID.

```bash
ravion environment execution get <id> [flags]
```

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

### Get deployment resource

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/deploy.mdx

Retrieves details for a specific deployment resource by ID.

```bash
ravion deploy resource get <id> [flags]
```

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

### Configure Manual Deployment Commands

Source: https://github.com/ravionhq/docs/blob/main/module-definitions/catalog/rvn-ec2-service.mdx

Use Manual mode for host-installed applications where deployment commands update the host directly. Ensure commands are repeatable as they run on every instance.

```text
Deploy type: Manual
Deploy commands:
  runuser -u app -- git -C /srv/orders pull --ff-only
  runuser -u app -- bash -c 'cd /srv/orders && ./bin/install-dependencies'
  runuser -u app -- bash -c 'cd /srv/orders && ./bin/build-assets'
Start command:
  exec runuser -u app -- /srv/orders/bin/server
```

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

### Apply project configuration

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/project.mdx

Applies a project configuration from a file. Use --dry-run to preview changes without applying them.

```bash
ravion project config apply <id> [flags]
```

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

### Get deployment details

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/deploy.mdx

Retrieves information about a specific deployment using its ID.

```bash
ravion deploy get <id> [flags]
```

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

### ravion code-source get

Source: https://github.com/ravionhq/docs/blob/main/cli/reference/code-source.mdx

Retrieves details for a specific code source by ID.

```APIDOC
## ravion code-source get

### Description
Get CodeSource by id.

### Usage
`ravion code-source get <id> [flags]`

### Flags
- **--json** (bool) - Optional - emit response as JSON
```

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

### Pull existing project configuration

Source: https://github.com/ravionhq/docs/blob/main/config-as-code/project-config-file.mdx

Downloads the current live configuration for an existing project into a local file.

```bash
ravion project config pull <project-id> --file ravion.yaml
```