{"id":20300734,"url":"https://github.com/carnesen-archive/bitcoin-config-cli","last_synced_at":"2026-04-24T21:33:47.862Z","repository":{"id":93300441,"uuid":"168249434","full_name":"carnesen-archive/bitcoin-config-cli","owner":"carnesen-archive","description":"A Node.js command-line interface for bitcoin server software configuration","archived":false,"fork":false,"pushed_at":"2019-02-09T17:52:54.000Z","size":29,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-08T14:33:23.646Z","etag":null,"topics":["bitcoin","carnesen","cli","configuration"],"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/carnesen-archive.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}},"created_at":"2019-01-30T00:03:59.000Z","updated_at":"2023-02-13T22:51:16.000Z","dependencies_parsed_at":"2023-07-16T20:52:13.910Z","dependency_job_id":null,"html_url":"https://github.com/carnesen-archive/bitcoin-config-cli","commit_stats":null,"previous_names":["carnesen/bitcoin-config-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/carnesen-archive/bitcoin-config-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carnesen-archive%2Fbitcoin-config-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carnesen-archive%2Fbitcoin-config-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carnesen-archive%2Fbitcoin-config-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carnesen-archive%2Fbitcoin-config-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/carnesen-archive","download_url":"https://codeload.github.com/carnesen-archive/bitcoin-config-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carnesen-archive%2Fbitcoin-config-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32241794,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T13:21:15.438Z","status":"ssl_error","status_checked_at":"2026-04-24T13:21:15.005Z","response_time":64,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bitcoin","carnesen","cli","configuration"],"created_at":"2024-11-14T16:20:50.826Z","updated_at":"2026-04-24T21:33:47.848Z","avatar_url":"https://github.com/carnesen-archive.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @carnesen/bitcoin-config-cli [![Build Status](https://travis-ci.com/carnesen/bitcoin-config-cli.svg?branch=master)](https://travis-ci.com/carnesen/bitcoin-config-cli)\nA Node.js command-line interface (CLI) for bitcoin server software configuration\n\n## Install\n```\nnpm install --global @carnesen/bitcoin-config-cli\n```\n^^ This installs this package to your global `node_modules` area. Probably you can now invoke this CLI from anywhere using the command `bitcoin-config`. If not you'll need modify your [`PATH`](https://en.wikipedia.org/wiki/PATH_(variable)).\n\n## Usage\nBy default this CLI reads/writes the default bitcoin configuration file location, e.g. `~/.bitcoin/bitcoin.conf` on Linux.\n\nThe CLI can take a JSON-serialized configuration object and write it as an INI-serialized string as expected by the bitcoin server software:\n```\n$ bitcoin-config write --json '{\"regtest\": true, \"daemon\": true}'\n```\nLet's check the contents of the configuration file:\n```\n$ bitcoin-config read --format ini\n# This is a bitcoin configuration file written using @carnesen/bitcoin-config\n\n# Run this node on its own independent test network.\nregtest=1\n\n# Spawn bitcoin as a background process\ndaemon=1\n```\nLooks good! Now suppose later we want to update a configuration file with a specific value:\n```\n$ bitcoin-config set --acceptnonstdtxn 1\n```\nThe \"set\" command preserves existing values and adds the one(s) specified:\n```\n$ bitcoin-config read\n{ regtest: true, daemon: true, acceptnonstdtxn: true }\n```\nBy now there are a TON of available bitcoin configuration options:\n```\n$ bitcoin-config set --help\nUsage: bitcoin-config set \u003coptions\u003e\n\nOptions:\n\n   [--acceptnonstdtxn \u003cstr\u003e] : Relay and mine non-standard transactions\n                               Allowed values {'0', '1'}\n   [--addresstype \u003cstr\u003e] : p2sh-segwit, legacy, or bech32\n   [--addnode \u003cstr0\u003e [...]] : Add a node IP address to attempt to connect to\n   [--addrmantest \u003cstr\u003e] : allows you to test address relay locally\n                           Allowed values {'0', '1'}\n   [--alertnotify \u003cstr\u003e] : Execute a command when an alert or long fork is received.\n                           \"%s\" in the command string is replaced by the alert message.\n...\n```\n\n## Usage as a library\nIn addition to providing a CLI, this npm package can also be used as a library in conjunction with [`@carnesen/cli`](https://github.com/carnesen/cli/):\n\n```ts\nimport { bitcoinConfig } from '@carnesen/bitcoin-config-cli';\nimport { branch, cli } from '@carnesen/cli';\n\nexport const root = branch({\n  commandName: 'awesome',\n  subcommands: [bitcoinConfig],\n})\n\nif (module === require.main) {\n  cli(root)();\n}\n```\n## Related\n- [@carnesen/bitcoin-config](https://github.com/carnesen/bitcoin-config): Constants, utilities, and TypeScript types for bitcoin server software configuration with Node.js\n- [@carnesen/cli](https://github.com/carnesen/cli): A library for building Node.js command-line interfaces\n\n## License\n\nMIT © [Chris Arnesen](https://www.carnesen.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarnesen-archive%2Fbitcoin-config-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarnesen-archive%2Fbitcoin-config-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarnesen-archive%2Fbitcoin-config-cli/lists"}