{"id":19000435,"url":"https://github.com/typesense/homebrew-tap","last_synced_at":"2025-04-22T17:06:47.099Z","repository":{"id":43199972,"uuid":"498173319","full_name":"typesense/homebrew-tap","owner":"typesense","description":"Homebrew Formulae for Typesense","archived":false,"fork":false,"pushed_at":"2025-02-22T04:10:01.000Z","size":52,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-17T07:17:30.569Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/typesense.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,"zenodo":null}},"created_at":"2022-05-31T03:29:53.000Z","updated_at":"2025-02-22T04:10:05.000Z","dependencies_parsed_at":"2025-02-21T18:20:02.550Z","dependency_job_id":"cc8cf293-ca37-4de6-8a93-18a2c6a3d533","html_url":"https://github.com/typesense/homebrew-tap","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fhomebrew-tap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fhomebrew-tap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fhomebrew-tap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fhomebrew-tap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typesense","download_url":"https://codeload.github.com/typesense/homebrew-tap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250285681,"owners_count":21405297,"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":[],"created_at":"2024-11-08T18:07:13.151Z","updated_at":"2025-04-22T17:06:47.054Z","avatar_url":"https://github.com/typesense.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typesense Homebrew Tap\n\nThis repo contains Typesense's Homebrew Tap.\n\n## Compatibility\n\nAs of Typesense v26.0, we only recommend using homebrew for macOS Ventura (13.x) or above.\n\nFor older versions of macOS, we recommend using the [Docker](https://typesense.org/docs/guide/install-typesense.html#docker) or [Docker Compose](https://typesense.org/docs/guide/install-typesense.html#docker-compose) installation method for compatibility and performance reasons.\n\n## Installation\n\nTo install the latest version of Typesense:\n\n```\nbrew install typesense/tap/typesense-server\n```\n\nTo install a specific version of Typesense:\n\n```\nbrew install typesense/tap/typesense-server@28.0\n```\n\n## Documentation\n\nFor brew docs: `brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).\n\n### Defaults\n\n- Configuration files are under: `${HOMEBREW_PREFIX}/etc/typesense/`\n- Logs are under: `${HOMEBREW_PREFIX}/var/log/typesense/`\n- Data dir is under: `${HOMEBREW_PREFIX}/var/lib/typesense/`\n- The default admin api-key is `xyz`.\n- The default API port is `8108`\n\nwhere `${HOMEBREW_PREFIX}` is usually `/usr/local`.\n\n### Start service\n\nTo start the `typesense-server` service:\n\n```\nbrew services start typesense-server\n```\n\nNow check the health of the server:\n\n```\ncurl http://localhost:8108/health\n{\"ok\":true}\n```\n\nIf you don't see `{\"ok\": true}`, check the logs under `${HOMEBREW_PREFIX}/var/log/typesense/` for any issues or progress.\n\n`${HOMEBREW_PREFIX}` is usually `/usr/local`.\n\n### Restart service\n\nTo restart the `typesense-server` service:\n\n```\nbrew services restart typesense-server\n```\n\n### Stop service\n\nTo stop the `typesense-server` service:\n\n```\nbrew services stop typesense-server\n```\n\n### Standalone\n\nYou can also run `typesense-server` from any path:\n\n```\nmkdir typesense-data\ntypesense-server --api-key=xyz --data-dir=./typesense-data\n```\n\n### Typesense Docs\n\nFor Typesense docs, see: [https://typesense.org/docs/api/](https://typesense.org/docs/api/)\n\n## Tap Developer Workflow\n\nThis section is only applicable if you're adding a new version to this tap.\n\n### Dependencies\n\n`brew install curl sha2` (curl is keg-only, so make sure it is available in `PATH` following the post-install instructions)\n\n### Add a new version\n\n1. Copy previous version to a new file called `./Formula/typesense-server@28.0.rb`\n2. Calculate SHA of ARM and x86_64 builds: `curl -sL https://dl.typesense.org/releases/28.0/typesense-server-28.0-darwin-\u003camd64|arm64\u003e.tar.gz | shasum -a 256`\n3. Update the SHA and URLs in the SHA, update the class name\n4. Run `cd Aliases; ln -sfn ../Formula/typesense-server@28.0.rb typesense-server`\n5. Run `brew style . --fix`\n6. Test locally `brew install ./Formula/typesense-server@28.0.rb --debug`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fhomebrew-tap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypesense%2Fhomebrew-tap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fhomebrew-tap/lists"}