Getting Started

Purpose

The socketry gem distributes conventions, design patterns, and reusable agent skills for developing and maintaining Socketry projects. It gives contributors and coding agents a common set of instructions for work such as implementing configuration DSLs, preparing pull requests, and maintaining GitHub repositories.

The guides are packaged as agent context, while task-specific instructions are packaged as skills. Use agent-context and agent-skills to install them from the gem into your project.

Installation

Add these gems to the maintenance group in your project's gems.rb or Gemfile:

group :maintenance, optional: true do
	gem "socketry"
	gem "agent-context"
	gem "agent-skills"
end

Enable the group and install the gems from the project root:

bundle config set --local with maintenance
bundle install

Install Agent Context

Install Socketry's guides locally:

bundle exec bake agent:context:install --gem socketry

This copies the guides into .context/socketry/ and updates the context index in your project's agents.md. Agents can follow those links to read conventions such as Pattern: Configuration & Builder.

To inspect the available context files:

bundle exec bake agent:context:list --gem socketry

Install Agent Skills

Install Socketry's reusable workflows locally:

bundle exec bake agent:skills:install --gem socketry

This copies the skills into .agents/skills/, including socketry-pull-request and socketry-github-repository. Each skill has a SKILL.md describing when to use it and the instructions to follow.

To inspect the available skills:

bundle exec bake agent:skills:list --gem socketry

Omit --gem socketry from either installer to install the context or skills provided by all dependencies in the bundle.

Update Local Guidance

After updating the gem, rerun both installers to refresh the local copies:

bundle update socketry
bundle exec bake agent:context:install --gem socketry
bundle exec bake agent:skills:install --gem socketry

Make changes to Socketry's guides and skills in this repository; installed copies are replaced when refreshed. The generated .context/ and .agents/ directories can be ignored in version control and recreated during local setup.