{"id":15593244,"url":"https://github.com/derhuerst/os-x-contacts","last_synced_at":"2025-04-15T05:36:55.120Z","repository":{"id":14023443,"uuid":"75674209","full_name":"derhuerst/os-x-contacts","owner":"derhuerst","description":"Query all macOS Address Book contacts.","archived":false,"fork":false,"pushed_at":"2023-08-21T14:05:06.000Z","size":29,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T05:36:50.021Z","etag":null,"topics":["address-book","contacts","macos","osx"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/derhuerst.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","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":"2016-12-05T23:04:44.000Z","updated_at":"2023-08-21T14:02:02.000Z","dependencies_parsed_at":"2024-10-03T00:15:46.675Z","dependency_job_id":null,"html_url":"https://github.com/derhuerst/os-x-contacts","commit_stats":{"total_commits":13,"total_committers":2,"mean_commits":6.5,"dds":"0.15384615384615385","last_synced_commit":"6954b2336d09279669ec2578d06e563e56581d0e"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fos-x-contacts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fos-x-contacts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fos-x-contacts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fos-x-contacts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/derhuerst","download_url":"https://codeload.github.com/derhuerst/os-x-contacts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249016306,"owners_count":21198828,"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":["address-book","contacts","macos","osx"],"created_at":"2024-10-03T00:05:39.326Z","updated_at":"2025-04-15T05:36:55.103Z","avatar_url":"https://github.com/derhuerst.png","language":"JavaScript","funding_links":["https://github.com/sponsors/derhuerst"],"categories":[],"sub_categories":[],"readme":"# *os-x-contacts*\n\n**Query all [macOS *Address Book*](https://support.apple.com/en-us/HT201728) contacts.** Uses [`contacts-cli`](https://github.com/pepebecker/contacts-cli) under the hood.\n\n[![npm version](https://img.shields.io/npm/v/os-x-contacts.svg)](https://www.npmjs.com/package/os-x-contacts)\n![ISC-licensed](https://img.shields.io/github/license/derhuerst/os-x-contacts.svg)\n![minimum Node.js version](https://img.shields.io/node/v/os-x-contacts.svg)\n[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)\n[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)\n\n\n## Installing\n\n```shell\nnpm install os-x-contacts\n```\n\n\n## Usage\n\nReturns a [readable stream](https://nodejs.org/api/stream.html#stream_class_stream_readable) in [object mode](https://nodejs.org/api/stream.html#stream_object_mode).\n\n```js\nimport {readContacts} from 'os-x-contacts'\n\nfor await (contact of contacts()) {\n\tconsole.log(contact)\n}\n```\n\n```js\n{\n\tlastName: 'Appleseed', firstName: 'John',\n\tphones: [ { label: 'mobile', value: '+49123456789' } ],\n\temails: [ { label: 'home', value: 'john.appleseed@example.org' } ]\n}\n{\n\tlastName: 'Appleseed', firstName: 'Jane',\n\tphones: [ { label: 'mobile', value: '+49123456789' } ],\n\temails: [ { label: 'home', value: 'jane.appleseed@example.org' } ]\n}\n```\n\n\n## Contributing\n\nIf you have a question or need support using `os-x-contacts`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, use [the issues page](https://github.com/derhuerst/os-x-contacts/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fos-x-contacts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderhuerst%2Fos-x-contacts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fos-x-contacts/lists"}