--- title: "obsidian-dev-utils" owner: "mnaoumov" source: "https://github.com/mnaoumov/obsidian-dev-utils" website: "/topics/obsidian" description: "Collection of essential functions and CLI tools designed to streamline your Obsidian plugin development process - mnaoumov/obsidian-dev-utils" stars: 60 tags: - "clippings" - "clippings/github" - "obsidian" - "obsidian_md" - "obsidian" - "obsidian_md" - "plugin_development" - "cli_tools" - "plugin_generator" - "styling" - "modals" - "debugging" - "plugin_helpers" date created: Saturday, May 3rd 2025, 2:38 pm --- ## README `Obsidian Dev Utils` is a collection of essential functions and CLI tools designed to streamline your Obsidian plugin development process. Whether you're building a plugin from scratch or enhancing an existing one, these utilities are here to simplify your workflow. ## What is Obsidian?[Obsidian](https://obsidian.md/) is a powerful knowledge base that works on top of a local folder of plain text Markdown files. It's a tool that lets you take notes and organize them, and it supports a rich plugin ecosystem that allows for extensive customization. ## Who Should Use This Package?This package is ideal for developers who are building or maintaining plugins for Obsidian. It provides a range of tools to make the development process easier, including automated builds, linting, spellchecking, and more. ## Plugin GeneratorThere is a [Obsidian Plugin Yeoman Generator](https://github.com/mnaoumov/generator-obsidian-plugin) that sets up a new Obsidian plugin project with a basic structure and some useful scripts from this library. ## InstallationTo install the package, run the following command: npm install obsidian-dev-utils ## Usage- [CLI Commands](https://github.com/mnaoumov/obsidian-dev-utils/blob/main/docs/cli-commands.md). - [Helper Functions](https://github.com/mnaoumov/obsidian-dev-utils/blob/main/docs/helper-functions.md) - [Styling](https://github.com/mnaoumov/obsidian-dev-utils/blob/main/docs/styling.md) - [Setting Components](https://github.com/mnaoumov/obsidian-dev-utils/blob/main/docs/setting-components.md) - [Modals](https://github.com/mnaoumov/obsidian-dev-utils/blob/main/docs/modals.md) - [Debugging](https://github.com/mnaoumov/obsidian-dev-utils/blob/main/docs/debugging.md) - [Plugin Helpers](https://github.com/mnaoumov/obsidian-dev-utils/blob/main/docs/plugin-helpers.md) ## Support[![Buy Me A Coffee](https://camo.githubusercontent.com/7b8f7343bfc6e3c65c7901846637b603fd812f1a5f768d8b0572558bde859eb9/68747470733a2f2f63646e2e6275796d6561636f666665652e636f6d2f627574746f6e732f76322f64656661756c742d79656c6c6f772e706e67)](https://www.buymeacoffee.com/mnaoumov) ## License© [Michael Naumov](https://github.com/mnaoumov/)