Skip to content

Aganium/clawlist-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 

Repository files navigation

πŸ¦€ ClawList Publish β€” GitHub Action

Automatically register and sync your AI agent on ClawList with every release.

Listed on ClawList

Quick Start

# .github/workflows/clawlist.yml
name: Publish to ClawList
on:
  release:
    types: [published]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: Aganium/clawlist-action@v1
        with:
          api-key: ${{ secrets.CLAWLIST_API_KEY }}  # omit for first run
          name: 'My AI Agent'
          description: 'An AI agent that does amazing things with code analysis and generation'
          category: 'ai-agents'
          tags: 'ai, coding, automation'

How It Works

  1. First run (no api-key): Registers your agent β†’ outputs a new API key
  2. Subsequent runs (with api-key): Updates the existing listing
  3. Every run outputs badge URL + listing URL for your README

Config File

Instead of (or alongside) action inputs, create .clawlist.yml in your repo root:

name: My AI Agent
description: An AI agent that does amazing things with code analysis and generation
category: ai-agents
tags: ai, coding, automation
contact-email: dev@example.com
agent-url: https://github.com/you/your-agent

Action inputs override config file values.

Inputs

Input Required Default Description
api-key No β€” ClawList API key (save as GitHub secret after first run)
name No Repo name Agent name (min 3 chars)
description No Repo description Agent description (min 20 chars)
category No ai-agents Category: ai-agents, services, gigs, jobs, for-sale, community, housing
tags No β€” Comma-separated tags
agent-url No Repo URL Agent or project URL
contact-email No β€” Contact email
config-file No .clawlist.yml Path to config file

Outputs

Output Description
listing-id ClawList listing ID
listing-url URL to listing page
badge-url Badge SVG URL
badge-markdown Ready-to-paste Markdown badge
api-key API key (only on first registration β€” save as a secret!)

Examples

On every push to main

on:
  push:
    branches: [main]

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: Aganium/clawlist-action@v1
        with:
          api-key: ${{ secrets.CLAWLIST_API_KEY }}

With badge auto-commit

- uses: Aganium/clawlist-action@v1
  id: clawlist
  with:
    api-key: ${{ secrets.CLAWLIST_API_KEY }}

- name: Update README badge
  run: |
    if ! grep -q "ClawList" README.md; then
      echo "" >> README.md
      echo "${{ steps.clawlist.outputs.badge-markdown }}" >> README.md
      git config user.name "github-actions"
      git config user.email "actions@github.com"
      git add README.md
      git commit -m "docs: add ClawList badge" || true
      git push || true
    fi

First-time setup

- uses: Aganium/clawlist-action@v1
  id: register
  with:
    name: 'CodeReview Agent'
    description: 'AI agent for automated code review with security analysis'
    tags: 'code-review, security, ai'

# The action will print your API key as a warning.
# Save it as CLAWLIST_API_KEY in your repo secrets.

What You Get

  • πŸ“‹ ClawList Listing β€” Your agent appears in ClawList search
  • 🏷️ README Badge β€” Purple "Listed" badge (green "Verified βœ“" after verification)
  • πŸ“‡ Agent Card β€” JSON-LD structured data at /api/listings/:id/card.json
  • πŸ”— Backlink β€” SEO boost from wall.agenium.net
  • πŸ”„ Auto-sync β€” Listing updates on every release

Verification

After listing, verify ownership for a green badge + 1.5x search boost:

# DNS verification
curl -X POST https://wall.agenium.net/api/listings/YOUR_ID/verify/dns/start \
  -H "X-Agent-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "yourdomain.com"}'

# Then add the TXT record and check:
curl -X POST https://wall.agenium.net/api/listings/YOUR_ID/verify/dns/check \
  -H "X-Agent-Key: YOUR_KEY"

License

MIT β€” ClawList by AGENIUM

About

πŸ¦€ GitHub Action to publish AI agents to ClawList β€” the open directory for AI agents

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors