profile-readme
Skill0 starsChanged 12 days agoMITView on GitHub
Creates or updates the GitHub profile README (the login/login repo) from live account data, with configurable sections and optional translated mirrors. Detects generated profile READMEs and edits their source and runs the generator instead of the output. Use when the user wants a new or refreshed GitHub profile README.
In this repository8 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- gh-auditSkill
- gh-normalizeSkill
- gh-onboardSkill
- profile-bioSkill
- readme-standardSkill
- release-workflowSkill
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 7 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈7
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 14
Run only when the user explicitly asks.
- Very specific: line 22
If not logged in, ask the user to run gh auth login and wait.
- Distinctive: line 37
Use an existing local clone if the user points to one.
- Very specific: line 46
If the repo doesn't exist, ask whether to create it (public, same name as the login).
- Distinctive: line 51
Check the signals in the standard's "Generated profile READMEs" section, in this order:
- Distinctive: line 76
Ask the user for content the API can't give (tagline, about text, focus themes) when those sections are configured.
- Distinctive: line 90
If the generator fails or the output isn't what the source suggests, stop and report.
- Distinctive: line 100
Never commit or push without explicit user approval.
- Distinctive: line 103
Keep the user's own sections.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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
profile-readme
Builds or updates README.md in the <login>/<login> repo (plus mirrors from
profile.mirrors). Uses live data. Never pushes without approval.
Run only when the user explicitly asks.
0. Preflight
gh auth status >/dev/null 2>&1 || echo "not logged in"If not logged in, ask the user to run gh auth login and wait.
1. Config
cfg="${GITHUB_MANAGER_HOME:-$HOME/.agents/github-manager}/config.json"
[ -f "$cfg" ] && cat "$cfg" || echo '{}'Keys used: language, profile.sections, profile.mirrors, profile.projectSources,
profile.stats. Schema: ../gh-audit/references/config.md. Standard and section catalogue:
references/profile-readme.md.
2. Get a working copy
Use an existing local clone if the user points to one; otherwise clone into a temp or chosen directory:
login=$(gh api user --jq .login)
gh repo view "$login/$login" >/dev/null 2>&1 || echo "profile repo missing"
gh repo clone "$login/$login" "<dir>"If the repo doesn't exist, ask whether to create it (public, same name as the login). Creating it
is an outward-facing write: wait for an explicit yes, then gh repo create "$login/$login" --public.
3. Generated or hand-written?
Check the signals in the standard's "Generated profile READMEs" section, in this order:
head -5 README.md
jq -r '.scripts // {} | to_entries[] | "\(.key): \(.value)"' package.json 2>/dev/null | grep -i readme
grep -lis 'readme' .github/workflows/*.y*ml 2>/dev/null
ls README.tmpl README.md.tpl templates scripts content data 2>/dev/null- Generated → go to step 5.
- Hand-written or missing → go to step 4.
- Unsure (markers without a clear generator, or a generator you can't run) → stop, show what you found and ask the user how to proceed.
4. Hand-written: build the README
- Collect data:
Plus every entry ingh api user --jq '{name,bio,blog,company,location}' gh api /user/social_accounts gh repo list "$login" --visibility public --source --no-archived --limit 300 \ --json name,description,primaryLanguage,repositoryTopics,homepageUrl,stargazerCountprofile.projectSources(local JSON/YAML/Markdown file or URL listing projects with canonical descriptions). - Ask the user for content the API can't give (tagline, about text, focus themes) when those sections are configured. Never invent it.
- Render the sections in
profile.sectionsorder. Keep sections the user wrote by hand that are not in the catalogue; ask before removing any. - For each code in
profile.mirrors, write a full translationREADME.<code>.mdand link it from the primary file after the intro block.
5. Generated: edit the source
- Identify the source files (data files, templates) and the generator command (a
package.jsonscript,make readme, a script inscripts/, or the workflow's command). - Edit only the source files. Never hand-edit the generated README.
- Install dependencies if needed (ask first if it downloads packages) and run the generator, then
its check command if one exists (
readme:check,--check, a CI step you can run locally). - If the generator fails or the output isn't what the source suggests, stop and report. Don't patch the output to make it pass.
6. Review and publish
Show git diff --stat and the full README diff. Commit and push only after the user explicitly
approves. Use a plain commit message describing the change, with no tool or agent attribution.
Rules
- Never commit or push without explicit user approval.
- Generated READMEs: source edits only; generator and check must pass.
- Content comes from the account, the repos, configured sources or the user, never invented.
- Keep the user's own sections; no attribution footer.
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.

