CipherSwarm Quick Reference#

Project → Campaign → Attack → Task → Agent
           ↓
        HashList → HashItem

Authorization: Bearer <24-char-token>

[APIRequest] - API requests
[APIError] - API errors
[AgentLifecycle] - Agent state changes
[BroadcastError] - WebSocket errors
[TaskPreemption] - Task preemption
[JobDiscarded] - Failed jobs

# All tests
COVERAGE=true bundle exec rspec

# Single file
bundle exec rspec spec/models/task_spec.rb

# Single test (line 42)
bundle exec rspec spec/models/task_spec.rb:42

# System tests (visible browser)
HEADLESS=false bundle exec rspec spec/system

# API tests only
bundle exec rspec spec/requests

# Basic
create(:task)
build(:agent)

# With traits
create(:agent, :benchmarked)
create(:task, :running)
create(:campaign, :high_priority)

# With overrides
create(:task, state: "completed", agent: my_agent)

class MyService
  def initialize(model)
    @model = model
  end

  def call
    # Business logic
  end
end

# Usage
MyService.new(model).call

class MyController < ApplicationController
  load_and_authorize_resource

  def index
    @items = @items.page(params[:page])
  end
end

# Success with body
render json: @task, status: :ok

# Success no body
head :no_content

# Error
render json: { error: "Message" }, status: :unprocessable_entity

Model.transaction do
  record.lock!
  record.update!(field: value)
end