Hercules CI Documentation
Support Dashboard
  • Hercules CI
      • Guides
        • Getting Started
          • 1. GitHub
          • 2. Deploy an Agent
            • 2a. Terraform
            • 2b. NixOps
            • 2c. NixOS
            • 2d. nix-darwin (macOS)
            • 2e. Manual
          • 3. Repository Setup
            • 3a. Your Own Repository
            • 3b. Minimal Repository
        • Upgrade to Agent 0.9
        • Update Agent using Nix Flakes
        • Multi-platform CI / Build Matrix
        • Agent as Remote Builder Client
        • Configure macOS for build server duty
        • Add USB devices to Effects
      • Effects Introduction (CI/CD)
      • Troubleshooting
      • Glossary
  • latest 0.9 0.8
    Hercules CI Agent
    • Agent Reference
      • Configuration Reference
        • Configuration File
        • binary-caches.json
        • secrets.json
        • Netrc
      • NixOS Module
      • Deployment Requirements
      • Job Definition
        • Evaluation
        • Effects
          • Effect Declaration
        • Legacy Evaluation
      • Security Reference
        • Data sharing overview
        • Repo and netrc security
        • Effects Security
    • hci Command Reference
      • Installation
      • Environment
      • hci effect run
      • hci login
      • hci secret add
      • hci secret echo
      • hci secret init-local
      • hci state get
      • hci state put
  • hercules-ci-effects
      • ⚠ NOTE ⚠ Effects are in beta.
      • Introduction
      • Guides
        • Import hercules-ci-effects
        • Deploy a NixOS machine
        • Deploy a NixOps network
        • Configure git-crypt
        • Write a Custom Effect
        • Deploy to GitHub Pages
        • Distribute a Static Binary with GitHub Releases
      • Effect Module Reference
        • Core Options
        • Git Options
      • Flake Parts Module Reference
        • flake-update
        • github-pages
      • Nix Functions Reference
        • General Functions
        • mkEffect
        • modularEffect
        • runIf
        • Command Functions
        • nix-shell
        • ssh
        • Deployment Functions
        • cargoPublish
        • netlifyDeploy
        • gitWriteBranch
        • runArion
        • runCachixDeploy
        • runNixDarwin
        • runNixOps
        • runNixOps2
        • runNixOS
        • Other Effect Functions
        • flakeUpdate
        • Developing Effects
        • effectVMTest
      • Hooks Reference
        • git-crypt-hook
      • Bash Functions Reference
        • getStateFile
        • putStateFile
        • readSecretJSON
        • readSecretString
        • useDockerHost
        • writeAWSSecret
        • writeDockerKey
        • writeGPGKey
        • writeSSHKey
Hercules CI Agent master
  • Arion Documentation
    • master
  • Hercules CI
    • master
  • Hercules CI Agent
    • master
    • 0.9
    • 0.8
  • hercules-ci-effects
    • master
  • Hercules CI Agent
  • Agent Reference
master 0.9 0.8
Edit this Page

Agent Reference

These documents provide a technical description of the agent.

For instructions to deploy an agent, use the setup guide instead.

Table of Contents

  • Configuration Reference

    • Configuration File

    • binary-caches.json

    • secrets.json

    • Netrc

  • NixOS Module

  • Deployment Requirements

  • Job Definition

    • Evaluation

    • Effects

      • Effect Declaration

    • Legacy Evaluation

  • Security Reference

    • Data sharing overview

    • Repo and netrc security

    • Effects Security

Privacy Policy | Terms | Service Status | Support

Copyright (C) 2019-2021 Ensius B.V.