{"id":17225210,"url":"https://github.com/tympanix/electron-regedit","last_synced_at":"2025-04-14T00:51:37.391Z","repository":{"id":19480728,"uuid":"79494588","full_name":"tympanix/electron-regedit","owner":"tympanix","description":"File associations, file icons \u0026 open with... for electron apps","archived":false,"fork":false,"pushed_at":"2022-11-10T17:53:20.000Z","size":78,"stargazers_count":37,"open_issues_count":6,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T14:55:13.051Z","etag":null,"topics":["electron","electron-regedit","file-icons","icons","registry","squirrel","windows","windows-registry"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tympanix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-19T20:58:41.000Z","updated_at":"2024-12-20T05:13:03.000Z","dependencies_parsed_at":"2023-01-11T20:28:46.837Z","dependency_job_id":null,"html_url":"https://github.com/tympanix/electron-regedit","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tympanix%2Felectron-regedit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tympanix%2Felectron-regedit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tympanix%2Felectron-regedit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tympanix%2Felectron-regedit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tympanix","download_url":"https://codeload.github.com/tympanix/electron-regedit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248804773,"owners_count":21164131,"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":["electron","electron-regedit","file-icons","icons","registry","squirrel","windows","windows-registry"],"created_at":"2024-10-15T04:13:00.099Z","updated_at":"2025-04-14T00:51:37.366Z","avatar_url":"https://github.com/tympanix.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# electron-regedit\nFile associations, file icons \u0026amp; open with... for electron apps\n\nThis module allows you to register your app in the windows registry, manipulate context menus \u0026 handle native open, edit, print, preview actions ect.\n\n## Installation\n```shell\nnpm install electron-regedit\n```\n\n## Usage\n### Toy Example\nAs a short documentation, here is how the module is used:\n```javascript\nconst {ProgId, ShellOption, Regedit} = require('electron-regedit')\n\nnew ProgId({\n    description: 'My App File',\n    icon: 'myicon.ico',\n    extensions: ['myapp'],\n    shell: [\n        new ShellOption({verb: ShellOption.OPEN}),\n        new ShellOption({verb: ShellOption.EDIT, args: ['--edit']}),\n        new ShellOption({verb: ShellOption.PRINT, args: ['--print']})\n    ]\n})\n\nRegedit.installAll()\n```\n\n### Squirrel integration\nYou will need to call ```Regedit.installAll()``` and ```Regedit.uninstallAll()``` when installing/uninstalling your application to clean up the registry. If you are using Squirrel there is a helping function to handle this. It is **very** important that all instantions of ```new ProgId({...})``` have been done **before** handling Squirrel events or installing/uninstalling into the registry.\n```javascript\nconst {Regedit} = require('electron-regedit')\n\n//... instantiate your ProgIds\n\nif (Regedit.squirrelStartupEvent()) return\n\n//... the rest of your application code\n```\n\n# Documentation\nPlease see the [wiki](https://github.com/Tympanix/electron-regedit/wiki) for detailed information\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftympanix%2Felectron-regedit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftympanix%2Felectron-regedit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftympanix%2Felectron-regedit/lists"}