{"id":24333106,"url":"https://github.com/tonyd33/porkbun-cli","last_synced_at":"2026-06-04T19:31:22.771Z","repository":{"id":272072257,"uuid":"915442121","full_name":"tonyd33/porkbun-cli","owner":"tonyd33","description":"A tiny shell script for interacting with the Porkbun API","archived":false,"fork":false,"pushed_at":"2025-01-24T04:55:11.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T13:48:04.981Z","etag":null,"topics":["api","api-client","dns","porkbun","porkbun-api","shell","shell-script"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tonyd33.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":"2025-01-11T21:16:59.000Z","updated_at":"2025-01-24T04:55:14.000Z","dependencies_parsed_at":"2025-01-11T22:23:55.989Z","dependency_job_id":"612a5950-73e4-4de7-ab89-ab5ab8c63dc3","html_url":"https://github.com/tonyd33/porkbun-cli","commit_stats":null,"previous_names":["tonyd33/porkbun-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tonyd33/porkbun-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyd33%2Fporkbun-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyd33%2Fporkbun-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyd33%2Fporkbun-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyd33%2Fporkbun-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tonyd33","download_url":"https://codeload.github.com/tonyd33/porkbun-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyd33%2Fporkbun-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33917183,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-04T02:00:06.755Z","response_time":64,"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":["api","api-client","dns","porkbun","porkbun-api","shell","shell-script"],"created_at":"2025-01-18T03:13:08.858Z","updated_at":"2026-06-04T19:31:22.742Z","avatar_url":"https://github.com/tonyd33.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# porkbun-cli\n\nA tiny shell script for interacting with the [Porkbun API](https://porkbun.com/api/json/v3/documentation).\n\n**See the [docs to get an API key](https://porkbun.com/api/json/v3/documentation#Authentication) first.**\n\n**[Quick start](#Examples)**\n\n## Dependencies\n\n- curl (widely available)\n- getopt (widely available)\n- jq\n\n## Configuration\n\nTo avoid having having your credentials stored in the command history, configure a file in `~/.config/porkbun-cli/credentials` with the content:\n```\nPORKBUN_API_KEY=\u003capi-key\u003e\nPORKBUN_SECRET_API_KEY\u003csecret-api-key\u003e\n```\n\n## Examples\n\n- Directly passing in credentials (see [configuration section](#configuration) to store credentials in a file)\n```sh\n./porkbun-cli.sh \\\n  --api-key pk_1234 \\\n  --secret-api-key sk_1234 -- \\\n  retrieve example.com\n```\n\n- Create a record ([reference](https://porkbun.com/api/json/v3/documentation#DNS%20Create%20Record))\n```sh\n./porkbun-cli.sh -- \\\n  create example.com www \\\n  --type A \\\n  --content 1.1.1.1\n```\n\n- Edit record by domain and id ([reference](https://porkbun.com/api/json/v3/documentation#DNS%20Edit%20Record%20by%20Domain%20and%20ID))\n```sh\n./porkbun-cli.sh -- \\\n  edit example.com 1234567890 \\\n  --type A \\\n  --name www \\\n  --content 1.1.1.1\n```\n\n- Edit record by domain, subdomain, and type ([reference](https://porkbun.com/api/json/v3/documentation#DNS%20Edit%20Record%20by%20Domain,%20Subdomain%20and%20Type))\n```sh\n./porkbun-cli.sh -- \\\n  edit-by-name-type example.com www \\\n  --type A \\\n  --content 1.1.1.1\n```\n\n- Delete record by id ([reference](https://porkbun.com/api/json/v3/documentation#DNS%20Delete%20Record%20by%20Domain%20and%20ID))\n```sh\n./porkbun-cli.sh -- \\\n  delete example.com 1234567890\n```\n\n- Delete record by domain, subdomain, and type ([reference](https://porkbun.com/api/json/v3/documentation#DNS%20Delete%20Records%20by%20Domain,%20Subdomain%20and%20Type))\n```sh\n./porkbun-cli.sh -- \\\n  delete-by-name-type example.com www \\\n  --type A\n```\n\n- Retrieve records by domain ([reference](https://porkbun.com/api/json/v3/documentation#DNS%20Retrieve%20Records%20by%20Domain%20or%20ID))\n```sh\n./porkbun-cli.sh -- \\\n  retrieve example.com\n```\n\n- Retrieve records by domain and id ([reference](https://porkbun.com/api/json/v3/documentation#DNS%20Retrieve%20Records%20by%20Domain%20or%20ID))\n```sh\n./porkbun-cli.sh -- \\\n  retrieve example.com 1234567890\n```\n\n- Upsert record by domain\n```sh\n# if no records exist for this domain, subdomain, type, then create it\n# if one record exists for this domain, subdomain, type, then update it\n# otherwise, error unless --multiple-behavior is set (see below)\n./porkbun-cli.sh -- \\\n  upsert-by-name-type example.com www \\\n  --type A \\\n  --content 1.1.1.1\n```\n\n- Uniquely upsert record by domain\n```sh\n# if no records exist for this domain, subdomain, type, then create it\n# if one record exists for this domain, subdomain, type, then update it\n# otherwise, delete all records for this domain, subdomain, type and then\n# create a new record\n./porkbun-cli.sh -- \\\n  upsert-by-name-type example.com www \\\n  --type A \\\n  --content 1.1.1.1 \\\n  --multiple-behavior unique\n```\n\n- Append upsert record by domain\n```sh\n# if no records exist for this domain, subdomain, type, then create it\n# if one record exists for this domain, subdomain, type, then update it\n# otherwise, append a new record\n./porkbun-cli.sh -- \\\n  upsert-by-name-type example.com www \\\n  --type A \\\n  --content 1.1.1.1 \\\n  --multiple-behavior append\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonyd33%2Fporkbun-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftonyd33%2Fporkbun-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonyd33%2Fporkbun-cli/lists"}