{"id":14812088,"url":"https://github.com/nybbles/obsidian-pocket","last_synced_at":"2025-09-16T14:31:32.639Z","repository":{"id":40365501,"uuid":"373709368","full_name":"nybbles/obsidian-pocket","owner":"nybbles","description":"Pocket integration for Obsidian","archived":true,"fork":false,"pushed_at":"2025-04-03T23:06:41.000Z","size":2287,"stargazers_count":248,"open_issues_count":0,"forks_count":24,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T00:20:01.593Z","etag":null,"topics":["obsidian-md","obsidian-plugin","pocket-api"],"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/nybbles.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-04T03:29:58.000Z","updated_at":"2025-04-03T23:10:03.000Z","dependencies_parsed_at":"2025-01-09T23:30:46.173Z","dependency_job_id":"fdeadb58-15f1-42a3-9577-0e28d1f7b712","html_url":"https://github.com/nybbles/obsidian-pocket","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":"obsidianmd/obsidian-sample-plugin","purl":"pkg:github/nybbles/obsidian-pocket","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nybbles%2Fobsidian-pocket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nybbles%2Fobsidian-pocket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nybbles%2Fobsidian-pocket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nybbles%2Fobsidian-pocket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nybbles","download_url":"https://codeload.github.com/nybbles/obsidian-pocket/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nybbles%2Fobsidian-pocket/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275432927,"owners_count":25463831,"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","status":"online","status_checked_at":"2025-09-16T02:00:10.229Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","obsidian-plugin","pocket-api"],"created_at":"2024-09-18T08:01:57.179Z","updated_at":"2025-09-16T14:31:32.630Z","avatar_url":"https://github.com/nybbles.png","language":"TypeScript","funding_links":["https://www.buymeacoffee.com/nybbles"],"categories":["TypeScript"],"sub_categories":[],"readme":"# obsidian-pocket\r\n\r\n\u003e :heavy_exclamation_mark: This project was archived for a few reasons. Most\r\n\u003e importantly, I (@nybbles) ran out of bandwidth for maintaining this plugin.\r\n\u003e Also, I simply stopped using Pocket and came to the conclusion that the owner\r\n\u003e of a commercial service should be developing a plugin for said service,\r\n\u003e rather than by people in their spare time.\r\n\u003e\r\n\u003e There were better alternatives to Pocket, like Omnivore, but now that that\r\n\u003e has been shut down, I simply use the Obsidian Web Clipper and manage my\r\n\u003e reading backlog directly in Obsidian. It works great! I highly recommend it,\r\n\u003e especially over using this plugin with Pocket.\r\n\u003e\r\n\u003e If you would like to take over the \"obsidian-pocket\" name in the\r\n\u003e Obsidian plugins list, please reach out to me and I will do what is needed to\r\n\u003e transfer it to you.\r\n\u003e\r\n\u003e Lastly, thank you everyone for your interest both using and contributing to\r\n\u003e this plugin, and my sincere apologies for being unresponsive lately. It was\r\n\u003e an honor to build some software that people found useful.\r\n\r\nThis plugin for [Obsidian](https://obsidian.md/) that allows you to sync your\r\n[Pocket](https://getpocket.com/) reading list into Obsidian, so that you can\r\neasily create Obsidian notes directly from your Pocket reading list.\r\n\r\n![pocket-list](https://raw.githubusercontent.com/nybbles/obsidian-pocket/master/images/pocket-list.png)\r\n\r\n## Initial setup\r\n\r\nAfter the plugin has been enabled, you will be able to see a \"Pocket\" option\r\nunder the \"Plugin options\" section of the settings panel. Click on it to go to\r\nthe obsidian-pocket settings tab, where you can connect your Pocket account and\r\nset up the obsidian-pocket plugin.\r\n\r\n### Connect your Pocket account\r\n\r\nClick on \"Connect your Pocket account\" to begin the Pocket authorization flow by\r\nopening a web page on your default browser. You will be asked whether you want\r\nto give permission to this plugin to access your Pocket data. Then you will be\r\nredirected back to Obsidian. Your Pocket account should now be connected.\r\n\r\nThe \"Disconnect your Pocket account\" button can be used to remove the Pocket\r\nauthorization that was just provided.\r\n\r\n### Specify settings\r\n\r\nThe obsidian-pocket settings tab will contain a number of settings that affect\r\nhow obsidian-pocket syncs Pocket items and creates Pocket item notes, as\r\ndescribed below:\r\n\r\n| Setting                                 | Default value                      | What it does                                                                                                                                                                                             |\r\n| --------------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| Create Pocket items on sync             | Enabled                            | Create Pocket item notes automatically when new Pocket items are synced                                                                                                                                  |\r\n| Multi-word Pocket tag converter options | Snake case                         | Specifies how to convert multi-word Pocket tags into Obsidian-compatible tags                                                                                                                            |\r\n| Pocket sync tag                         | Blank (sync all Pocket items)      | Specifies a Pocket tag so that only Pocket items with that tag will be synced                                                                                                                            |\r\n| Pocket item notes folder location       | Obsidian vault root folder         | Specifies the folder whether new Pocket item notes will be stored                                                                                                                                        |\r\n| Pocket item note template file location | Blank (use the default template)   | Specifies a custom template file to use to create new Pocket item notes                                                                                                                                  |\r\n| Front matter URL key                    | URL (matches the default template) | Specifies the [YAML front matter](https://help.obsidian.md/Advanced+topics/YAML+front+matter) key that will be used to find the Pocket item's URL, used to match Pocket items to their respective notes. |\r\n\r\nIt is highly encouraged that you use the default Pocket item notes template and\r\nfront matter URL key. If you decide to customize these option, please ensure\r\nthat your Pocket item notes do end up having a valid front matter key for Pocket\r\nitem URL.\r\n\r\n## Usage\r\n\r\n### Available commands\r\n\r\n| Command                      | What it does                                                                                                                                     |\r\n| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |\r\n| Open Pocket list             | Opens a list in Obsidian where you can see your synced Pocket items and go to the Pocket URL, the original URL or create/open a Pocket item note |\r\n| Sync Pocket list             | Syncs Pocket items from Pocket to Obsidian                                                                                                       |\r\n| Index all files by URL       | Find all Pocket item notes in the vault by checking whether a file has a URL front matter key that matches a synced Pocket item                  |\r\n| Create all Pocket item notes | Creates a Pocket item note for all Pocket items that lack one                                                                                    |\r\n\r\n### Syncing Pocket items\r\n\r\nYou can sync your Pocket items using an Obsidian command: \"Sync Pocket list\", or\r\nthe button in the obsidian-pocket settings tab.\r\n\r\nYou can either sync all Pocket items or just Pocket items with a particular tag\r\nthat you specify, using the \"Pocket sync tag\" setting. Leave it blank to sync\r\nall Pocket items, or specify a Pocket tag to limit your sync to just Pocket\r\nitems with that tag.\r\n\r\n### Opening and using the Pocket list\r\n\r\nOnce the Pocket list is downloaded and stored, open the command palette and\r\nsearch for \"Pocket\" to see the list of available commands. The command to open\r\nthe Pocket list is \"Open Pocket list\". The Pocket list is shown in a screenshot\r\nabove.\r\n\r\nThe Pocket list can be used to browse through the items you've saved to Pocket\r\nand to create a note for any Pocket item by clicking on its title. You can also\r\ngo directly to the URL for the Pocket item.\r\n\r\n### Pocket tags in Obsidian\r\n\r\nPocket tags are synced and presented in the Pocket list. Pocket supports tags\r\nwith spaces in them, whereas Obsidian does not. The way that obsidian-pocket\r\nhandles Pocket tags with spaces can be configured in the \"Multi-word Pocket tag\r\nconverter options\" setting shown in the screenshot above.\r\n\r\nThe available options are:\r\n\r\n- (Enabled by default) Snake case ('#tag with spaces' becomes #tag_with_spaces)\r\n- Camel case ('#tag with spaces' becomes #TagWithSpaces)\r\n- Do nothing ('#tag with spaces' remains unchanged)\r\n\r\nThese settings only affect the Pocket tags displayed in the Pocket list, and the\r\ntags that are inserted into a Pocket item note if you have `{{tags}}` in your\r\nPocket item note template (see below for using templates for Pocket item\r\nnotes). They do not affect already-existing Obsidian tags or Pocket tags.\r\n\r\n### Notes for Pocket items\r\n\r\nClick on any Pocket item's title to create a note (or navigate to an existing\r\nnote) for that Pocket item. Notes for Pocket items will be created in the Pocket\r\nitem notes folder, which can be configured in settings. If no Pocket item notes\r\nfolder is set, then Pocket item notes will be created in the root folder.\r\n\r\nA template for new Pocket item notes can be specified in settings.\r\n\r\nOpen the Pocket item URL in your browser using Meta+click for Linux and Mac OS\r\n(e.g. command+click on Mac OS) and using Alt+click for Windows.\r\n\r\nNotes in Obisidan are matched to Pocket items based on a specific tag in their\r\n[frontmatter](https://help.obsidian.md/Advanced+topics/YAML+front+matter). The\r\ntag that is used is \"URL\" by default, but can be changed in settings.\r\n\r\nThis means that while Pocket item notes are created by default in the Pocket\r\nitems notes folder, they can be moved elsewhere and/or renamed without breaking\r\nthe connection to the Pocket item with matching URL. It also means that you can\r\ncreate notes with the URL frontmatter and they will be automatically connected\r\nto the relevant Pocket item note with the matching URL, although the Pocket item\r\ntemplate would not be used in that case.\r\n\r\nUse the \"Index all files by URL\" command to ensure that `obsidian-pocket` knows\r\nabout all files that contain a frontmatter tag for URL, thereby allow it to\r\nmatch those notes to Pocket items. This index is maintained by `obsidian-pocket`\r\nautomatically, so you should not need to run it.\r\n\r\n\u003e :warning: As of version 0.8.0 of obsidian-pocket, Obsidian notes are matched to\r\n\u003e Pocket items only using the front matter URL key, and no longer matched by\r\n\u003e title. The last version to support matching by title was version 0.7.2. This\r\n\u003e functionality was removed because it did not work correctly with Pocket items\r\n\u003e that had the same title, but different URLs.\r\n\r\n## Using custom templates for Pocket notes\r\n\r\n\u003e :warning: Please use the default template and front matter URL key, unless you\r\n\u003e are confident that you can customize these settings while ensuring that the\r\n\u003e Pocket item notes have valid frontmatter YAML and that the URL frontmatter key\r\n\u003e matches what you have asked obsidian-pocket to look for.\r\n\r\nTemplates for Pocket notes work similar to any other template in Obsidian, see\r\n[here](https://help.obsidian.md/Plugins/Templates), except that only the\r\nfollowing variables are supported:\r\n\r\n| Variable name      | What it means                                           |\r\n| ------------------ | ------------------------------------------------------- |\r\n| `{{title}}`        | The title of the Pocket item                            |\r\n| `{{url}}`          | The URL of the Pocket item                              |\r\n| `{{pocket-url}}`   | The URL to open the Pocket item in Pocket               |\r\n| `{{excerpt}}`      | The excerpt extracted by Pocket for the Pocket item     |\r\n| `{{tags-no-hash}}` | The Pocket tags for the Pocket item                     |\r\n| `{{tags}}`         | The Pocket tags for the Pocket item, with \"#\" prepended |\r\n| `{{image}}`        | The main image for the Pocket item                      |\r\n\r\nThis is the default template in obsidian-pocket. It will populate the [YAML\r\nfrontmatter](https://help.obsidian.md/Advanced+topics/YAML+front+matter) of the\r\nPocket item note with all available metadata used in the correct places so that\r\nYAML frontmatter is valid, hashtags work correctly and the Pocket item's main\r\nimage is displayed (if available):\r\n\r\n```\r\n---\r\nTitle: \"{{title}}\"\r\nURL: {{url}}\r\nPocket URL: {{pocket-url}}\r\nTags: [pocket, {{tags-no-hash}}]\r\nExcerpt: \u003e\r\n    {{excerpt}}\r\n---\r\n{{tags}}\r\n{{image}}\r\n```\r\n\r\nIf you had saved [this\r\nURL](https://www.technologyreview.com/2021/07/08/1027908/carbon-removal-hype-is-a-dangerous-distraction-climate-change/)\r\nto Pocket with the tag \"Carbon removal\", synced it to Obsidian using this plugin\r\nand then created a note for the corresponding Pocket item with the above\r\ntemplate, your note would start off containing the following:\r\n\r\n```\r\n---\r\nTitle: \"Carbon removal hype is becoming a dangerous distraction\"\r\nURL: https://www.technologyreview.com/2021/07/08/1027908/carbon-removal-hype-is-a-dangerous-distraction-climate-change/\r\nPocket URL: https://getpocket.com/read/1337\r\nTags: [pocket, carbon_removal]\r\nExcerpt: \u003e\r\n    In February, oil giant Shell trumpeted a scenario in which the world pulls\r\n    global warming back to 1.5 ˚C by 2100, even as natural gas, oil, and coal\r\n    continue to generate huge shares of the world’s energy.\r\n---\r\n#carbon_removal\r\n![image](http://via.placeholder.com/640x360)\r\n```\r\n\r\nNote that in the example template, the title is quoted so that the YAML\r\nfrontmatter is valid, even if the Pocket item has a title with colons in it.\r\n\r\n## Feature requests, bug reports and PRs\r\n\r\nFeature requests, bug reports and PRs are welcome! Please use\r\nhttps://github.com/nybbles/obsidian-pocket/issues for this. Please file feature\r\nrequests under https://github.com/nybbles/obsidian-pocket/labels/enhancement, or\r\ncomment in existing feature requests to indicate your interest.\r\n\r\nPlease provide console logs if you are filing a bug report, so that it can be\r\nreproduced and fixed. You can copy/paste console logs from the Obsidian dev\r\nconsole, which can be opened by going to View \u003e Toggle Developer Tools in\r\nObsidian.\r\n\r\n## Design overview and security considerations\r\n\r\nThis plugin runs completely locally. The only external party it communicates\r\nwith is Pocket, via the [Pocket API](https://getpocket.com/developer/). All of\r\nyour data from Pocket and your Pocket access token are stored locally.\r\n\r\nThis plugin stores your Pocket data locally in Obsidian's IndexedDB.\r\n\r\n## Support\r\n\r\nIf you find this plugin valuable, please let me know! It is great to hear from\r\npeople who use what I've built. If you really like this plugin and want to\r\nexpress that by buying me a coffee, please do 🙏🏾.\r\n\r\n[![\"Buy Me A Coffee\"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/nybbles)\r\n\r\n_Please don't feel obligated to donate!_\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnybbles%2Fobsidian-pocket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnybbles%2Fobsidian-pocket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnybbles%2Fobsidian-pocket/lists"}