{
 "kind": "tool",
 "slug": "obsidian",
 "path": "tools/obsidian/",
 "name": "Obsidian API",
 "maker": null,
 "density": "basic",
 "crumbs": [
  [
   "Tools",
   "tools/"
  ],
  [
   "SDKs for hosted services",
   "tools/service-sdks/"
  ]
 ],
 "lead": "Type definitions for building Obsidian plugins.",
 "chips": [
  {
   "label": "SDKs for hosted services",
   "path": "tools/service-sdks/"
  },
  {
   "label": "NPM"
  }
 ],
 "primary": {
  "label": "Copy install command",
  "copy": "npm install obsidian"
 },
 "links": [
  {
   "label": "GitHub",
   "href": "https://github.com/obsidianmd/obsidian-api"
  },
  {
   "label": "Website",
   "href": "https://obsidian.md"
  }
 ],
 "track": "New versions, deprecation and license changes on your dashboard",
 "verdicts": [
  {
   "key": "license",
   "label": "License",
   "value": "MIT",
   "status": "yes",
   "sub": "Use it in paid apps",
   "quote": null,
   "note": "License from npm.",
   "src": "https://github.com/obsidianmd/obsidian-api"
  },
  {
   "key": "maint",
   "label": "Maintained",
   "value": "Maintained",
   "status": "yes",
   "sub": "Last change Nov 10, 2026",
   "note": "",
   "src": "https://github.com/obsidianmd/obsidian-api"
  },
  {
   "key": "pop",
   "label": "Used by agents' projects",
   "value": "3 projects",
   "status": "info",
   "sub": "#137 of 284 in its category",
   "note": "Dependency in 3 public GitHub projects set up for AI coding agents that we scanned (0.0%).",
   "src": null
  },
  {
   "key": "agent",
   "label": "Agent access",
   "value": "Official agent skills",
   "status": "yes",
   "sub": "1 from the makers",
   "note": "Agent skills for this library in the skills catalog; community skills are written by others, read them before you install.",
   "src": null
  }
 ],
 "vfoot": "From the package registry and GitHub, checked daily.",
 "blocks": [
  {
   "id": "overview",
   "nav": "Overview",
   "h2": "What Obsidian API does",
   "parts": [
    {
     "t": "prose",
     "text": "Type definitions for building Obsidian plugins."
    }
   ]
  },
  {
   "id": "popularity",
   "nav": "Popularity",
   "h2": "Obsidian API popularity",
   "parts": [
    {
     "t": "stats",
     "items": [
      {
       "n": "40",
       "of": "/ 100",
       "l": "Gid Score, #2981 overall"
      },
      {
       "n": "183K",
       "l": "downloads a week, npm"
      },
      {
       "n": "2,358",
       "l": "GitHub stars"
      },
      {
       "n": "3",
       "l": "agent projects use it"
      }
     ]
    },
    {
     "t": "small",
     "text": "Gid Score measures public popularity and activity, not quality.",
     "link": "How the Gid Score is calculated",
     "path": "tools/top/"
    }
   ]
  },
  {
   "id": "usage",
   "nav": "How it is used",
   "h2": "How Obsidian API is used",
   "parts": [
    {
     "t": "list",
     "items": [
      "Obsidian API is a dependency in 3 of the 6,253 public GitHub projects set up for AI coding agents that we scanned, too few to describe it from them alone. Our scan also samples projects by dependency (Solana 3,061, Ethereum and EVM 1,772, 3D and games 3,120, agent frameworks and SDKs 13,593); counting those, it appears in 26 projects, and what it is used with below comes from all of them.",
      "Projects that use it most often also use esbuild (88.5%), TypeScript (100.0%), ESLint (80.8%)."
     ]
    },
    {
     "t": "h3",
     "text": "Often used with"
    },
    {
     "t": "rows",
     "rows": [
      {
       "l": "In 88.5% of its projects",
       "v": "esbuild",
       "path": "tools/esbuild/"
      },
      {
       "l": "In 100.0% of its projects",
       "v": "TypeScript",
       "path": "tools/typescript/"
      },
      {
       "l": "In 80.8% of its projects",
       "v": "ESLint",
       "path": "tools/eslint/"
      },
      {
       "l": "In 38.5% of its projects",
       "v": "CodeMirror",
       "path": "tools/codemirror/"
      },
      {
       "l": "In 34.6% of its projects",
       "v": "Anthropic SDK",
       "path": "tools/anthropic-ai/"
      },
      {
       "l": "In 50.0% of its projects",
       "v": "Vitest",
       "path": "tools/vitest/"
      },
      {
       "l": "In 26.9% of its projects",
       "v": "yaml",
       "path": "tools/yaml/"
      },
      {
       "l": "In 26.9% of its projects",
       "v": "stylelint",
       "path": "tools/stylelint/"
      }
     ]
    }
   ]
  },
  {
   "id": "more",
   "nav": null,
   "spy_as": "usage",
   "h2": "More about Obsidian API",
   "parts": [
    {
     "t": "more",
     "items": [
      {
       "title": "Agent Skills for it",
       "path": "skills/",
       "items": [
        ": Agent skills for Obsidian. Teach your agent to use Obsidian CLI and open formats including Markdown, Bases, JSON Canvas.",
        "obsidian-bases: Explain, draft, and validate Obsidian Bases .base files with filters, formulas, properties, summaries, and table, card, list, or version-gat",
        "obsidian-kb-artifacts: Use this skill for Obsidian-native formatting and derived artifacts such as Markdown formatting, wikilinks, registry tables, canvas files, o",
        "obsidian-bases: Create and edit Obsidian Bases (.base files) with views, filters, formulas, and summaries. Use when working with .base files, creating datab",
        "obsidian-second-brain: Operate any Obsidian vault as a living, self-rewriting second brain (an evolution of Karpathy's LLM Wiki pattern: sources rewrite existing p",
        "obsidian-bases: Create and edit Obsidian Bases (.base files) with views, filters, formulas, and summaries. Use when working with .base files, creating datab"
       ]
      },
      {
       "title": "More in SDKs for hosted services",
       "path": "tools/service-sdks/",
       "items": [
        {
         "text": "Supabase JS",
         "path": "tools/supabase-supabase-js/"
        },
        {
         "text": "Supabase SSR",
         "path": "tools/supabase-ssr/"
        },
        {
         "text": "AWS SDK for JavaScript (S3)",
         "path": "tools/aws-sdk-client-s3/"
        },
        {
         "text": "Resend",
         "path": "tools/resend-npm/"
        },
        {
         "text": "Stripe (JavaScript)",
         "path": "tools/stripe-node/"
        },
        {
         "text": "Supabase CLI",
         "path": "tools/supabase-npm/"
        },
        {
         "text": "Firebase",
         "path": "tools/firebase-node/"
        },
        {
         "text": "Stripe.js",
         "path": "tools/stripe-npm/"
        }
       ]
      }
     ]
    }
   ]
  },
  {
   "id": "alternatives",
   "nav": "Alternatives",
   "h2": "Alternatives",
   "parts": [
    {
     "t": "alts",
     "items": [
      {
       "name": "Obsidian API",
       "me": true,
       "facts": [
        "MIT",
        "Gid 40",
        "183K/wk"
       ]
      }
     ],
     "more": "Compare Obsidian API with another tool",
     "more_path": "tools/compare/"
    }
   ]
  },
  {
   "id": "start",
   "nav": "Get started",
   "h2": "Get started",
   "parts": [
    {
     "t": "install",
     "intro": "Install it.",
     "code": "npm install obsidian"
    },
    {
     "t": "gap",
     "text": "No step-by-step start for Obsidian API yet: we have not written its hand-checked card."
    }
   ]
  }
 ],
 "glance": [
  [
   "Package",
   "npm obsidian"
  ],
  [
   "Category",
   "SDKs for hosted services"
  ],
  [
   "License",
   "MIT"
  ],
  [
   "Gid Score",
   "40.3"
  ],
  [
   "Rank in category",
   "#137 of 284"
  ],
  [
   "GitHub",
   "obsidianmd/obsidian-api"
  ],
  [
   "Last change",
   "Nov 10, 2026"
  ]
 ],
 "good": [],
 "checked_line": "From the package registry, GitHub and our scan of public agent projects; numbers update daily."
}