Castellan
Reference · Developer Herald
The Developer Herald's settings, files and commands
Every setting with its default, where the Developer Herald keeps its files, its command line, and its local API.
- Article
- 1504
- Applies to
- Developer Herald 0.9.3
- Last reviewed
- For
- For developers
Settings#
On its page, under Settings in the title bar. Each shows its value, its default and a line on what it does, with Reset to default. They're kept in %USERPROFILE%\.developer-herald\settings.json, and apply from the next round.
| Setting | Default | What it does |
|---|---|---|
| Keywords | None | What makes a release relevant, case for case. None: only a tracked issue does. |
| Release feeds | None | Each a repository (owner/name), with its own keywords, Quiet unless relevant, and a note. |
| Tracked issues | None | Each a repository, an issue number and a note. |
| Hugging Face | No author, no searches | An author, and searches among their models: a term, Relevant, and a note. |
| Suggested feeds | On, none dismissed | Suggest them, and (under Advanced) the repositories not suggested again. |
| Plain-words notes | On | A short summary of each new release by a local model, labelled. Off: the release's own notes only. |
| A round every (Advanced) | 360 minutes | How often a round comes, 60 to 10,080 minutes. |
| Releases read per repo (Advanced) | 10 | Read from each repository every round, 1 to 30. |
| Model calls per round (Advanced) | 6 | Releases summarised a round, never more than 6. 0: none. |
How to fill them in is in Choose what the Developer Herald follows.
Files#
All in %USERPROFILE%\.developer-herald:
| File | What's in it |
|---|---|
settings.json | Its settings. |
state.json | Each feed's status and what it has seen, and the newest 400 news items. |
read.json | Which items you marked read. |
summaries.json, answers.json | The model's summaries by release, and its answers by question, each with where it was written. |
notes.json | Release notes waiting for a summary. |
suggestions.json, packages.json | The suggested feeds as last found, and each package's GitHub repository. |
server.json, serve.log | The running page's process, port and token, and its log. |
It writes nowhere else. DEVELOPER_HERALD_HOME moves its data folder, and DEVELOPER_HERALD_PORT its page.
Commands#
Run with node $HOME\.developer-herald\app\src\cli.ts <command>:
| Command | What it does |
|---|---|
run | One round here and now, and what it found. |
start | On duty: its rounds run on their schedule, and its page is up. Castellan's Start. |
stop | Off duty: its scheduled rounds pause. The page stays up, and Run now still works. Castellan's Stop. |
open | Makes sure its page is up, without changing duty. |
shutdown | Ends its page's process, and with it any round. |
status | Exits 0 when on duty and working, 3 when not. --json prints what Castellan reads. |
uninstall | Removes it and its sign-in task. --purge removes its data too; --dry-run says what it would do. |
Its rounds run inside its page's process, so stopping it in Castellan stops its work.
Local API#
At http://developer-herald.localhost:19898/, answering only this PC:
| Address | What it answers |
|---|---|
GET /api/ping | Its version and duty, with unread (unread news) and relevant (how many of those are relevant). |
GET /api/news | The unread items and the feeds, as JSON. |
Related articles
Is this page right?
If something on it is wrong or out of date, tell us and we'll fix the page.
Still stuck? Write to support@castellan-software.com and mention article 1504. Every version of Developer Herald, and what changed in it, is in its release notes.