Skip to content

RSS and Atom

Start with a connected interface. Choose Web for your own setup, or CLI / Agent for terminal instructions.

Set up in the Web app

Choose a publication's RSS or Atom feed URL, not its normal homepage.

  1. Prepare the Extension: inkcre/rss version 0.2.0 for Core Host 0.2.x. Select your online Core client to install it, then enable it there. No CLI or browser Extension is needed for this collector.
  2. Open Sources and the create-source form. Set Nickname to My first feed.
  3. Choose Type extensions.rss.rss.Source, or extensions.rss.atom.Source for Atom.
  4. Paste this object into Config, replacing the feed URL:
json
{
  "feed_url": "https://YOUR-PUBLICATION/FEED",
  "fetch_full_text": false,
  "download_enclosures": false
}
  1. Save/create the Source, then open it from the list. Run a Collection and inspect its Job before indexing and searching.

The Config editor takes only the object above, not a CLI wrapper containing nickname and config. These options avoid extra article fetches and attachment downloads. A feed exposes only what its publisher currently provides; a successful Job is not an import of the full archive. After finding a known item, schedule collection.

Before you start, connect the CLI to your instance.

Choose a publication you already read and copy its RSS or Atom feed URL. Its normal homepage URL is not usually a feed URL. Look for an RSS/Subscribe link on the publication.

Enable the collector

Install the RSS Extension on Core, then enable it:

sh
inkcre-cli extension install inkcre/rss --version 0.2.0
inkcre-cli extension enable inkcre/rss
inkcre-cli source types

Version 0.2.0 is a published Python release for Core Host 0.2.x. For a different Host version, check the RSS release listing for a published release with a compatible python.host_sdk_version. Do not guess a version or use latest. If already installed, inspect inkcre-cli extension get inkcre/rss before changing it.

The type list should contain extensions.rss.rss.Source and extensions.rss.atom.Source. In the Web app, select Core under Control Extension on Client to control the collector, not This browser.

Add and run the source

  1. Create feed.json in your local working folder:

    json
    {
      "nickname": "My first feed",
      "config": {
        "feed_url": "https://YOUR-PUBLICATION/FEED",
        "fetch_full_text": false,
        "download_enclosures": false
      }
    }

    Replace the URL. These first-run settings collect feed content without extra article fetches or attachment downloads.

  2. Create the Source, choosing the matching feed format:

    sh
    inkcre-cli source create --type extensions.rss.rss.Source --input feed.json

    For Atom, use extensions.rss.atom.Source. Record the returned Source id.

  3. Run a Collection using that Source ID. The guide shows the collection command, how to wait for its separate Job ID, and what to inspect if it fails.

Checkpoint: the collection Job finished. A feed exposes only what its publisher currently provides; success does not mean its entire historical archive was imported.

Next: Find what you saved, then schedule collection.