Developer Documentation

Developer
Documentation

Everything you need to get started with RISC-V Runners. From quick setup guides to advanced configuration options.

Quick Start

Get up and running with RISC-V Runners in minutes

Sign Up

Create your free account and get 3,000 minutes to start building

Get Token

Copy your runner token from the dashboard

Deploy

Add the token to your CI/CD pipeline and start building

Platform Integration

Choose your CI/CD platform and follow the setup guide

GitLab Integration

Set up RISC-V runners for your GitLab projects

1. Add Runner Token

Add your runner token to your GitLab project settings

2. Configure .gitlab-ci.yml

# .gitlab-ci.yml
stages:
  - build
  - test

build_riscv:
  stage: build
  image: riscvrunners/runner:latest
  script:
    - echo "Building for RISC-V architecture"
    - make build
  tags:
    - riscv-runners

GitHub Integration

Use RISC-V runners with GitHub Actions

1. Configure Runner

Set up your runner in the GitHub Actions settings

2. Create Workflow

# .github/workflows/riscv.yml
name: RISC-V Build
on: [push, pull_request]

jobs:
  build:
    runs-on: riscv-runners
    steps:
      - uses: actions/checkout@v3
      - name: Build for RISC-V
        run: |
          echo "Building for RISC-V architecture"
          make build

Docker Configuration

Use our pre-built Docker images for consistent RISC-V environments

Base Docker Image

Start with our optimized RISC-V base image

Available Images

riscvrunners/base:latest - Base RISC-V environment

riscvrunners/runner:latest - Pre-configured runner

riscvrunners/dev:latest - Development tools included

Example Dockerfile

# Dockerfile for RISC-V
FROM riscvrunners/base:latest

# Install your dependencies
RUN apt-get update && apt-get install -y \
    build-essential \
    cmake \
    git

# Copy your source code
COPY . /app
WORKDIR /app

# Build your application
RUN make build

# Run your application
CMD ["./your-app"]

Additional Resources

Explore more resources to get the most out of RISC-V Runners

API Reference

Complete API documentation for programmatic access

Examples

Real-world examples and sample configurations

Best Practices

Optimization tips and performance guidelines

Tutorials

Step-by-step tutorials for common use cases

Need Help?

Can't find what you're looking for? Our support team is here to help.

DeveloperDocumentation