cyrus-setup-endpoint
Skill902 starsChanged 53 days agoApache-2.0View on GitHub
Configure the public webhook endpoint for Cyrus — ngrok, Cloudflare Tunnel, or custom URL.
- Reads credentials
- Installs packages
1 other project uses a version of this.
Adopted by
Most recently taken up by
- ceedaragents/cyrusword for word, first seen Oct 8, 2026
Other versions1 project uses a version of this.
Word for word · 1
- ceedaragents/cyrus★ 888100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository21 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- packages/CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- googleSkill
- release-core-testSkill
- cyrus-setup-claude-authSkill
- cyrus-setup-githubSkill
- cyrus-setup-gitlabSkill
- cyrus-setup-launchSkill
- cyrus-setup-linearSkill
- cyrus-setup-prerequisitesSkill
- cyrus-setup-repositorySkill
- cyrus-setupSkill
- cyrus-setup-slackSkill
- debugSkill
- f1-test-driveSkill
- implementationSkill
- investigateSkill
- releaseSkill
- summarizeSkill
- verify-and-shipSkill
The file
We split this skill into the rules it gives an agent
7 rules. About 0 are common, 3 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 18
If CYRUS_BASE_URL is already set, inform the user:
- Distinctive: line 47
If not installed, provide install instructions:
- Distinctive: line 70
Ask the user to provide:
- Very specific: line 78
Write the ngrok config so it can be started with ngrok start cyrus:
- Distinctive: line 144
Ask the user for:
- Very specific: line 168
Ask the user for their URL.
- Very specific: line 176
Ensure these are present in ~/.cyrus/.env (add only if missing):
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
CRITICAL: Never use Read, Edit, or Write tools on ~/.cyrus/.env or any file inside ~/.cyrus/. Use only Bash commands (grep, printf >>, etc.) to interact with env files — secrets must never be read into the conversation context.
Setup Endpoint
Configures a public URL so Linear (and other integrations) can send webhooks to your Cyrus instance.
Step 1: Check Existing Configuration
grep -E '^CYRUS_BASE_URL=' ~/.cyrus/.env 2>/dev/nullIf CYRUS_BASE_URL is already set, inform the user:
Webhook endpoint already configured:
<value>To reconfigure, removeCYRUS_BASE_URLfrom~/.cyrus/.envand re-run this skill.
Skip to Step 4 (write port/webhooks if missing).
Step 2: Choose Endpoint Method
Ask the user:
How will you expose Cyrus to the internet for webhooks?
- ngrok (recommended — every free account includes one static domain that persists across restarts)
- Cloudflare Tunnel (permanent, requires Cloudflare account)
- Own URL (you already have a public URL/domain)
Important: ngrok's free tier includes a permanent static domain — do NOT tell the user this is a paid feature or that URLs change on restart. Every free ngrok account gets one static domain at https://dashboard.ngrok.com/domains.
Step 3: Configure Endpoint
Option 1: ngrok
3a. Check if ngrok is installed
which ngrokIf not installed, provide install instructions:
macOS:
brew install ngrokLinux:
curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok-v3-stable-linux-amd64.tgz | sudo tar xvz -C /usr/local/bin3b. Guide ngrok domain setup
Instruct the user:
ngrok provides a free static domain so your URL doesn't change between restarts.
- Sign up or log in at https://dashboard.ngrok.com
- Go to https://dashboard.ngrok.com/domains
- Copy your free static domain (e.g.,
your-name-here.ngrok-free.app)- Go to https://dashboard.ngrok.com/get-started/your-authtoken and copy your authtoken
Ask the user to provide:
- Their ngrok domain
- Their ngrok authtoken
CRITICAL: The authtoken is a secret. Use clipboard-to-file commands.
3c. Write ngrok configuration
Write the ngrok config so it can be started with ngrok start cyrus:
mkdir -p ~/.config/ngrokThen write ~/.config/ngrok/ngrok.yml (merge with existing if present):
version: 3
agent:
authtoken: <token>
endpoints:
- name: cyrus
url: <domain>
upstream:
url: 3456For the authtoken, use a clipboard-to-file approach:
macOS:
# User copies authtoken, then runs:
NGROK_TOKEN=$(pbpaste) && cat > ~/.config/ngrok/ngrok.yml << EOF
version: 3
agent:
authtoken: $NGROK_TOKEN
endpoints:
- name: cyrus
url: <domain>
upstream:
url: 3456
EOFUniversal fallback:
read -s -p "Paste your ngrok authtoken: " NGROK_TOKEN && cat > ~/.config/ngrok/ngrok.yml << EOF
version: 3
agent:
authtoken: $NGROK_TOKEN
endpoints:
- name: cyrus
url: <domain>
upstream:
url: 3456
EOF
echo " ✓ Saved"3d. Write CYRUS_BASE_URL
printf 'CYRUS_BASE_URL=https://%s\n' "<domain>" >> ~/.cyrus/.envWhere <domain> is the ngrok domain the user provided (e.g., your-name-here.ngrok-free.app).
Inform the user:
To start ngrok, run:
ngrok start cyrusRun this in a separate terminal before starting Cyrus.
Option 2: Cloudflare Tunnel
Ask the user for:
- Their Cloudflare Tunnel token
- Their tunnel hostname (e.g.,
cyrus.yourdomain.com)
Token is a secret — use clipboard-to-env:
macOS:
printf 'CLOUDFLARE_TOKEN=%s\n' "$(pbpaste)" >> ~/.cyrus/.envUniversal fallback:
read -s -p "Paste your Cloudflare token: " val && printf 'CLOUDFLARE_TOKEN=%s\n' "$val" >> ~/.cyrus/.env && echo " ✓ Saved"Then write the base URL (not a secret — agent can write directly):
printf 'CYRUS_BASE_URL=https://<hostname>\n' >> ~/.cyrus/.envOption 3: Own URL
Ask the user for their URL. Validate it starts with https://.
printf 'CYRUS_BASE_URL=%s\n' "<url>" >> ~/.cyrus/.envStep 4: Write Common Config
Ensure these are present in ~/.cyrus/.env (add only if missing):
grep -q '^CYRUS_SERVER_PORT=' ~/.cyrus/.env 2>/dev/null || printf 'CYRUS_SERVER_PORT=3456\n' >> ~/.cyrus/.env
grep -q '^LINEAR_DIRECT_WEBHOOKS=' ~/.cyrus/.env 2>/dev/null || printf 'LINEAR_DIRECT_WEBHOOKS=true\n' >> ~/.cyrus/.env
grep -q '^CYRUS_HOST_EXTERNAL=' ~/.cyrus/.env 2>/dev/null || printf 'CYRUS_HOST_EXTERNAL=true\n' >> ~/.cyrus/.envLINEAR_DIRECT_WEBHOOKS=true enables direct Linear webhook signature verification. CYRUS_HOST_EXTERNAL=true enables direct Slack and GitHub webhook signature verification. Both are required for self-hosted setups where webhooks come directly from the services (not forwarded through CYHOST).
Completion
✓ Webhook endpoint configured:
<CYRUS_BASE_URL>✓ Server port: 3456 ✓ Direct webhooks: enabled
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

