{"id":13772091,"url":"https://github.com/coffee-cup/obsidian-vault-parser","last_synced_at":"2025-10-16T14:05:04.332Z","repository":{"id":37807155,"uuid":"324717391","full_name":"coffee-cup/obsidian-vault-parser","owner":"coffee-cup","description":"Vault parser for the Obsidian note taking app","archived":false,"fork":false,"pushed_at":"2023-03-06T12:59:13.000Z","size":406,"stargazers_count":35,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-08T23:03:47.707Z","etag":null,"topics":["obsidian-md","parser","vault"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coffee-cup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-12-27T08:21:06.000Z","updated_at":"2025-02-21T03:49:45.000Z","dependencies_parsed_at":"2024-01-12T15:13:31.463Z","dependency_job_id":null,"html_url":"https://github.com/coffee-cup/obsidian-vault-parser","commit_stats":{"total_commits":56,"total_committers":3,"mean_commits":"18.666666666666668","dds":0.3392857142857143,"last_synced_commit":"88b041d0be9c92efd505d26c091df153dc8ff768"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coffee-cup%2Fobsidian-vault-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coffee-cup%2Fobsidian-vault-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coffee-cup%2Fobsidian-vault-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coffee-cup%2Fobsidian-vault-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coffee-cup","download_url":"https://codeload.github.com/coffee-cup/obsidian-vault-parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248563008,"owners_count":21125193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["obsidian-md","parser","vault"],"created_at":"2024-08-03T17:00:59.875Z","updated_at":"2025-10-16T14:04:59.289Z","avatar_url":"https://github.com/coffee-cup.png","language":"TypeScript","funding_links":[],"categories":["Creating Plugins","TypeScript"],"sub_categories":[],"readme":"# obsidian-vault-parser\n\n![CI](https://github.com/coffee-cup/obsidian-vault-parser/workflows/CI/badge.svg)\n[![](https://img.shields.io/npm/v/obsidian-vault-parser?style=flat-square)](https://www.npmjs.com/package/obsidian-vault-parser)\n[![](https://img.shields.io/github/license/coffee-cup/obsidian-vault-parser?style=flat-square\u0026color=brightgreen)](https://github.com/coffee-cup/obsidian-vault-parser/blob/main/LICENSE)\n\nVault parser for the [Obsidian](https://obsidian.md/) note taking app.\n\n## Usage\n\nRead an Obsidian vault from a path\n\n```ts\nimport { readVault } from \"obsidian-vault-parser\"\n\nconst vault = readVault(\"./path/to/vault\")\nconsole.log(vault)\n```\n\n`obsidian-vault-parser` also has the ability to only include files that are\n_published_. You can pass an `isPublished` predicate in as an option. Files that\ndo not pass this predicate will not be included in the vault.\n\n```ts\nimport { readVault } from \"obsidian-vault-parser\"\n\nconst vault = readVault(\"./path/to/vault\", {\n  isPublished: file =\u003e file.frontMatter.published != null\n})\n```\n\n## Documentation\n\n### `Vault`\n\nRepresents an entire Obsidian vault.\n\n```ts\nexport interface Vault {\n  path: string;\n  files: Record\u003cstring, VaultPage\u003e;\n  config: VaultConfig;\n}\n```\n\n### `VaultConfig`\n\nParsed contents of `.obsidian/config`.\n\n```ts\nexport interface VaultConfig {\n  theme?: string;\n  vimMode?: boolean;\n  attachmentFolderPath?: string;\n  pluginEnabledStatus?: any;\n}\n```\n\n### `VaultFile`\n\nRepresents an individual file inside of a vault.\n\n```ts\nexport interface VaultPage {\n  path: string;\n  name: string;\n  tags: string[];\n  links: string[];\n  backLinks: string[];\n  frontMatter: Record\u003cstring, any\u003e;\n  content: string;\n  createdAt: number;\n  updatedAt: number;\n}\n```\n\n**`path`**\n\nAbsolute path to the file.\n\n**`name`**\n\nName of the file that can be referenced by other files in the vault. This must\nbe unique across the vault.\n\ne.g. file with path `./foo/bar.md` is `bar`.\n\n**`tags`**\n\nA list of `#tags` found in the file\n\n**`links`**\n\nNames of other files that this file [[links]] to with.\n\n**`backLinks`**\n\nNames of other files that link to this file.\n\n**`frontMatter`**\n\n[Front matter](https://jekyllrb.com/docs/front-matter/) parsed from the top of the file.\n\n**`content`**\n\nString content of the document with front matter removed.\n\n**`createdAt`**\n\nBirthtime of file in milliseconds.\n\n**`updatedAt`**\n\nLast modified date of file in milliseconds.\n\n### `readVault(path: string) =\u003e Vault`\n\nRead an Obsidian Vault from a file path.\n\n## TypeScript\n\nTypeScript types are included with this library.\n\n## Test\n\nRun all tests\n\n```\nyarn test\n```\n\n---\n\nThis project was bootstrapped with [tsdx](https://github.com/formium/tsdx).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoffee-cup%2Fobsidian-vault-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoffee-cup%2Fobsidian-vault-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoffee-cup%2Fobsidian-vault-parser/lists"}