Canto-remote(1)

💅 CANTO-REMOTE 💅

so bestie, real talk — this is Canto-remote(1), a page from the General Commands Manual, and it's basically the little remote control situation for canto-daemon. It gives you some capability to configure and query canto-daemon without dragging a whole full client along. Perfect for scripting, or for interfacing with other programs. iykyk 🎀

---

✨ COMMAND LINE USAGE ✨

the whole vibe in one line, no cap:

canto-remote (options) [command] (arguments)

---

🌸 OPTIONS 🌸

okay so here's your flag menu, literally all of them:

• -V — prints version info and dips out. that's it, that's the whole job 💅
• -h, --help — print usage help
• -D, --dir [directory] — change the base directory for canto-daemon. the default is $XDG_CONFIG_HOME/canto
• --noplugins — disable all the plugins. every last one. 🙈
• --enableplugins 'plugin1 plugin2...' — enable these plugins. this one overrides --noplugins, so it's the main character here 👑
• --disableplugins 'plugin1 plugin2...' — disable these plugins
• -a, --address [IP] — attempt to connect to address instead of the local Unix socket. defaults to loopback (127.0.0.1)
• -p, --port [port] — use port when you're connecting with -a

---

🦋 COMMANDS 🦋

Canto-remote supports various commands to configure canto-daemon — although ngl, using a real client is recommended. but hey, we're here, let's go 🫶

• help [command] — get help on a specific command
• addfeed [URL] (username=user password=secret) (name="Some name") — subscribe to a feed, optionally with special arguments. if you don't specify a name, the feed's title gets used instead ✨
• listfeeds — list all subscribed feeds
• delfeed [name or listfeeds index] — unsubscribe from a feed
• status (--tag=tag) (--read|--total|--tags) — print the number of unread items, optionally restricted to a specific tag. --read prints read items, --total prints total items, --tags prints the value for all tags.

NOTE: this is still subject to filters, so if you're filtering all read items, --read will never return anything but 0. like... ever. 😭 that's not a bug bestie that's just the filters doing their thing.

• force-update — refetch all feeds, regardless of timestamps 🔥
• config (="value") — change a configuration variable. (you probably don't want to do this by hand, use a client 💀)
• one-config (= value) — change a single configuration variable, assuming the entire line is one setting. (you probably don't want to do this by hand either — use a client, bestie)
• export — write an OPML formatted list of feeds to stdout (i.e. canto-remote export > feedlist.opml)
• import — import an OPML formatted list of feeds from stdin (i.e. canto-remote import < feedlist.opml)
• kill — kill the daemon you're connecting to 💀 dramatic but effective
• script — run a script (testing code)

NOTE: plugins can also add remote commands, like sync, which will also be listed with --help (or no arguments). so if --help shows you stuff that isn't on this list, that's why 👑

---

🧚 HOMEPAGE 🧚

the plug, the link, the source of truth:

http://codezen.org/canto-ng

---

⭐ AUTHOR ⭐

the icon behind it all: Jack Miller <jack@codezen.org> 💖

---

🌈 SEE ALSO 🌈

• canto-daemon(1) — go read that one too, bestie, it's the whole other half of the story

---

and that's the page!! 🎀 this was Canto-remote, from the General Commands Manual, dated Canto-remote — slay, periodt, go script something cute 💜✨