Skip to content
中文

Tip of the Day: an online file and a weekly crawl

  1. Fetch. When the Overview page opens, HarnessKit downloads tips/tips.json from the repository RealZST/harnesskit-resources on GitHub.
  2. Cache. A successful download is saved in local storage under the key harnesskit-tips-cache. If a download fails, the page uses that copy. The copy has no expiry date. The next successful download replaces it.
  3. Filter. HarnessKit keeps the tips for agents it detects on your machine, plus tips marked general.
  4. Pick. The kept tips cycle in file order, one per day. The tip changes at 00:00 UTC. A new agent or a new tip in the file can also change the day’s pick.
  5. Show. The tip appears with a badge that names its agent and links to its source page. If no tip matches your agents, the Overview shows no tip card.

Each entry in the file has three fields:

{
"agent": "claude",
"tip": "Use @path/to/import syntax in CLAUDE.md to import additional files. Imported files are expanded and loaded into context at launch alongside the CLAUDE.md that references them.",
"source": "https://code.claude.com/docs/en/memory"
}

The agent value is the agent’s id in HarnessKit, such as claude, codex, or windsurf for Devin Desktop.

A GitHub Actions workflow in the same repository proposes new tips.

  1. Schedule. It is scheduled for every Monday at 00:00 UTC.
  2. Read sources. It downloads the official doc pages and repository docs listed in tips/sources.json.
  3. Score sentences. An action verb near the start, such as “Use”, “Run” or “Press”, adds 2 points. Command syntax, keyboard shortcuts, flags, file names and inline code add 1 point each. A sentence needs 2 points to stay.
  4. Drop duplicates. A candidate is dropped when 60% or more of its keywords match an existing tip.
  5. Report. It opens an issue labelled tips-discovery with at most 5 candidates per agent.

A maintainer then checks each candidate against tips/TIPS_GUIDELINES.md in the same repository. A tip must tell the reader what to do, with concrete commands, paths or keys. It must match an official source. Tips about HarnessKit itself are not allowed. The maintainer condenses each accepted candidate into one or two sentences and adds it to tips.json. To add a tip yourself, see Contributing tips and CLI listings.

  • src/pages/overview.tsx fetches the tips file, caches it and picks the day’s tip.
  • RealZST/harnesskit-resources: .github/workflows/discover-tips.yml schedules the weekly crawl.
  • RealZST/harnesskit-resources: .github/scripts/discover_tips.py reads the sources, scores sentences and opens the issue.
  • RealZST/harnesskit-resources: tips/TIPS_GUIDELINES.md sets the review rules and the list of agent ids.