Skip to content
SkillModel-led997 tokens in use

Obsidian Headless

Run Obsidian Sync and Publish from a terminal, a server or CI with the ob command.

53,311 stars on the repository MIT Licenseobsidianmd/obsidian-skills · plugins/obsidian/skills/obsidian-headless
npx skills add https://github.com/obsidianmd/obsidian-skills
View source

Install command as written in the repository's README

Skill label

measured from its files

What installing Obsidian Headless costs

69tokens idle
997tokens in use

Idle is what sits in context while the skill is installed. In use is its instructions, loaded when it runs. Counts are approximate, made offline with cl100k_base.

Model dependence Model-led

Script-ledMixedModel-led

Mostly instructions, so how well it works depends on the model that follows them.

This describes the skill's structure, how much of it is scripts. It does not say how well it works.

Touches

shelldetectednetworkdetected

Declared tags come from the skill's frontmatter; detected ones from its scripts, its code blocks and the commands it names in inline code. This is detected, not audited.

How it scores

Quality

How well the skill is written, counted from its own files: its frontmatter, its steps, examples, stated output and constraints, its size and whether every file it ships is one it names.How we score it →
Good
  • Frontmatter12/15
  • Structure9/25
  • Examples9/15
  • Output10/15
  • Size15/15
  • Resources10/15

Security

Starts at 100 and loses points for each thing in the skill's files that a reader should look at first.How we score it →
Excellent
  • Runs shell commands−5

    does this on the machine, and the frontmatter does not say so

    SKILL.md, line 33

Repository health

Pre-computed score based on development activity, maintenance, community, maturity, and trend momentum.How we score it →
Good
  • Development activity100
  • Maintenance84
  • Community60
  • Maturity32
  • Momentum40

Obsidian Headless is an agent skill for the ob command line tool, which runs Obsidian Sync and Obsidian Publish without the desktop app. It covers logging in, creating and linking vaults, running one-off or continuous syncs, changing sync settings and publishing notes to a site.

It sets limits for the assistant: the user types passwords, a dry run comes before a publish, and risky sync modes need confirmation.

What You Get

  • Command examples for sync, sync settings and publish
  • Safety rules for credentials, vault paths and remote changes
  • Notes on Node.js 22 and the subscriptions Sync and Publish need

Common Use Cases

  • Syncing a vault on a server
  • Publishing notes from CI
  • Changing Sync or Publish settings

What Makes It Unique

It is written around caution with accounts and remote state. It says to pass the vault path explicitly, back up before a first sync, and never use desktop Sync and Headless Sync on the same vault on one device.

Under The Hood

The skill is one SKILL.md with no scripts. The assistant runs the ob command in a shell, which signs in to your Obsidian account and sends vault files to Obsidian Sync or Publish servers. Commands can change remote vault and site state, and the install needs npm.

Join founders building with open source

Opinionated takes, migration guides, cost-saving tips, and insights from the open source ecosystem.

Subscribe on SubstackJoin 750+ subscribers