{"_id":"@upbit-official/upbit-cli","_rev":"10-5b699feedea490971e1cd67e6d1d75ba","name":"@upbit-official/upbit-cli","dist-tags":{"latest":"1.0.0"},"versions":{"0.9.1":{"name":"@upbit-official/upbit-cli","version":"0.9.1","keywords":["upbit","cli","cryptocurrency","exchange","api"],"license":"Apache-2.0","_id":"@upbit-official/upbit-cli@0.9.1","maintainers":[{"name":"elias-dunamu","email":"elias@dunamu.com"},{"name":"dale-park","email":"dale@dunamu.com"}],"homepage":"https://github.com/upbit-official/upbit-cli","bugs":{"url":"https://github.com/upbit-official/upbit-cli/issues"},"bin":{"upbit":"run.js"},"dist":{"shasum":"e3d5144c6bb6cab4ed7cddb53ac3fd19fc778750","tarball":"https://registry.npmjs.org/@upbit-official/upbit-cli/-/upbit-cli-0.9.1.tgz","fileCount":5,"integrity":"sha512-6AKB5BF18ejs9JyDE93+Jt8lr1uA2IuWSvEbKDeMoUeZqLijLcyVpgXPuqcYfmnb3o1FWZnWQIRwfVjKmFHL0w==","signatures":[{"sig":"MEUCIBHWvSf+5ZOtHaGj1mB3rCXX0WdCn7j8N/PZZBZqz3bgAiEA8D8yQqSwTcfl1HnAGJhaRaIctkIGYTKlRkKTrKEFcxQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":13401},"engines":{"node":">=18"},"gitHead":"7f8ebc078675ee20bd63ba7f3e92bf5a973a325b","scripts":{"postinstall":"node install.js"},"_npmUser":{"name":"elias-dunamu","email":"elias@dunamu.com"},"repository":{"url":"git+https://github.com/upbit-official/upbit-cli.git","type":"git"},"_npmVersion":"11.12.1","description":"Upbit CLI — command-line interface for the Upbit API","directories":{},"_nodeVersion":"25.9.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"preferUnplugged":true,"_npmOperationalInternal":{"tmp":"tmp/upbit-cli_0.9.1_1778047516327_0.7159990024829077","host":"s3://npm-registry-packages-npm-production"}},"0.9.2":{"name":"@upbit-official/upbit-cli","version":"0.9.2","keywords":["upbit","cli","cryptocurrency","exchange","api"],"license":"Apache-2.0","_id":"@upbit-official/upbit-cli@0.9.2","maintainers":[{"name":"elias-dunamu","email":"elias@dunamu.com"},{"name":"dale-park","email":"dale@dunamu.com"},{"name":"que-dunamu","email":"que@dunamu.com"}],"homepage":"https://github.com/upbit-official/upbit-cli","bugs":{"url":"https://github.com/upbit-official/upbit-cli/issues"},"bin":{"upbit":"run.js"},"dist":{"shasum":"26a26d37342a8ade284d0f3559bd8aea190681e6","tarball":"https://registry.npmjs.org/@upbit-official/upbit-cli/-/upbit-cli-0.9.2.tgz","fileCount":4,"integrity":"sha512-nUNiUo+aF0ieE65DhLA8gA3X7PB4hiF5HWwzQbxrnliQpPGrVyHdGhBmSw4227PAg9FIqTUKtvvgo64e+VbWRA==","signatures":[{"sig":"MEQCIFyhkmm3kLInI/4KaLxbwjBKD6bwZxkOOj6PyQDH8HL/AiBQTFzvThQaVnq0NgWyCByQe6pew0hCFeuOIvqS/j/khA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":8863},"engines":{"node":">=18"},"gitHead":"d7b9910e621f36b31b8f67eea6e1d08043e66aac","scripts":{"postinstall":"node install.js"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:759201f7-0f2b-45ad-8df3-1ad0d275b379"}},"repository":{"url":"git+https://github.com/upbit-official/upbit-cli.git","type":"git"},"_npmVersion":"11.16.0","description":"Upbit CLI — command-line interface for the Upbit API","directories":{},"_nodeVersion":"24.18.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"preferUnplugged":true,"_npmOperationalInternal":{"tmp":"tmp/upbit-cli_0.9.2_1784787647882_0.5699793741840753","host":"s3://npm-registry-packages-npm-production"}},"0.9.3":{"name":"@upbit-official/upbit-cli","version":"0.9.3","keywords":["upbit","cli","cryptocurrency","exchange","api"],"license":"Apache-2.0","_id":"@upbit-official/upbit-cli@0.9.3","maintainers":[{"name":"elias-dunamu","email":"elias@dunamu.com"},{"name":"dale-park","email":"dale@dunamu.com"},{"name":"que-dunamu","email":"que@dunamu.com"}],"homepage":"https://github.com/upbit-official/upbit-cli","bugs":{"url":"https://github.com/upbit-official/upbit-cli/issues"},"bin":{"upbit":"run.js"},"dist":{"shasum":"6d5b135baf6300932c91af6abc2a06467beb4a6b","tarball":"https://registry.npmjs.org/@upbit-official/upbit-cli/-/upbit-cli-0.9.3.tgz","fileCount":7,"integrity":"sha512-9+D/KOHFrQZwdIvlZue9VRbnMk0fkBZpxU032BmRvx5WPKAgY2hru1IJhdHb2xT4rvRGbg0sYkjOyM48AbFtxQ==","signatures":[{"sig":"MEYCIQCJ5xE4e1LAiRCa68FdYsMHdlvy1EkmNeHgCQbGcGZH2gIhAMZzVn8JnelQJK7BpnxykshAkasq5JYQL634ryIX+kj5","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":29450},"engines":{"node":">=18"},"gitHead":"d8ea5db01b8fc963ce784b7454cfda17daaf4b43","scripts":{"postinstall":"node install.js"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:759201f7-0f2b-45ad-8df3-1ad0d275b379"}},"repository":{"url":"git+https://github.com/upbit-official/upbit-cli.git","type":"git"},"_npmVersion":"11.16.0","description":"Upbit CLI — command-line interface for the Upbit API","directories":{},"_nodeVersion":"24.18.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"preferUnplugged":true,"_npmOperationalInternal":{"tmp":"tmp/upbit-cli_0.9.3_1784789611733_0.14853382185692676","host":"s3://npm-registry-packages-npm-production"}},"1.0.0":{"name":"@upbit-official/upbit-cli","version":"1.0.0","keywords":["upbit","cli","cryptocurrency","exchange","api"],"license":"Apache-2.0","_id":"@upbit-official/upbit-cli@1.0.0","maintainers":[{"name":"elias-dunamu","email":"elias@dunamu.com"},{"name":"dale-park","email":"dale@dunamu.com"},{"name":"que-dunamu","email":"que@dunamu.com"}],"homepage":"https://github.com/upbit-official/upbit-cli","bugs":{"url":"https://github.com/upbit-official/upbit-cli/issues"},"bin":{"upbit":"run.js"},"dist":{"shasum":"e56b7d8226a420135f0af71ef0883aef04c1d643","tarball":"https://registry.npmjs.org/@upbit-official/upbit-cli/-/upbit-cli-1.0.0.tgz","fileCount":7,"integrity":"sha512-NB4HCTRLiaGB+2dWD56rKF3iB5wM3EtiZb7Gn2ptjXcgnywQtWjd1YPmG/aDuslBX8hwlIzNdRd7Dg8MudFl6Q==","signatures":[{"sig":"MEYCIQChsiE0n75w3K9NHgMVTlYERjUNwJe+dLmkdQAZKipTfQIhAONm+4jFJGC2EQze0JBDGNm1sLp1HMqyHqMCihxn39zb","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":29450},"engines":{"node":">=18"},"gitHead":"ff07de91466bf9c47a8c4fe6a4648eb4d16d20eb","scripts":{"postinstall":"node install.js"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:759201f7-0f2b-45ad-8df3-1ad0d275b379"}},"repository":{"url":"git+https://github.com/upbit-official/upbit-cli.git","type":"git"},"_npmVersion":"11.17.0","description":"Upbit CLI — command-line interface for the Upbit API","directories":{},"_nodeVersion":"24.19.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"preferUnplugged":true,"_npmOperationalInternal":{"tmp":"tmp/upbit-cli_1.0.0_1788240622951_0.42910210668166693","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-05-06T06:05:16.244Z","modified":"2026-10-21T06:47:07.813Z","0.9.0":"2026-05-06T05:33:16.423Z","0.9.1":"2026-05-06T06:05:16.543Z","0.9.2":"2026-07-23T06:20:48.012Z","0.9.3":"2026-07-23T06:53:31.860Z","1.0.0":"2026-09-01T05:30:23.091Z"},"bugs":{"url":"https://github.com/upbit-official/upbit-cli/issues"},"license":"Apache-2.0","homepage":"https://github.com/upbit-official/upbit-cli","keywords":["upbit","cli","cryptocurrency","exchange","api"],"repository":{"url":"git+https://github.com/upbit-official/upbit-cli.git","type":"git"},"description":"Upbit CLI — command-line interface for the Upbit API","maintainers":[{"email":"elias@dunamu.com","name":"elias-dunamu"},{"email":"dale@dunamu.com","name":"dale-park"},{"email":"trevor@dunamu.com","name":"trevor_dunamu"}],"readme":"English | [한국어](./README_KR.md)\n\n# Upbit CLI\n\nThe official CLI for the [Upbit REST API](https://docs.upbit.com).\n\n<!-- x-release-please-start-version -->\n\n## Installation\n\n### Installing with npm\n\n```sh\nnpm install -g @upbit-official/upbit-cli\n```\n\n### Installing with Go\n\nTo test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed.\n\n```sh\ngo install 'github.com/upbit-official/upbit-cli/cmd/upbit@latest'\n```\n\nOnce you have run `go install`, the binary is placed in your Go bin directory:\n\n- **Default location**: `$HOME/go/bin` (or `$GOPATH/bin` if GOPATH is set)\n- **Check your path**: Run `go env GOPATH` to see the base directory\n\nIf commands aren't found after installation, add the Go bin directory to your PATH:\n\n```sh\n# Add to your shell profile (.zshrc, .bashrc, etc.)\nexport PATH=\"$PATH:$(go env GOPATH)/bin\"\n```\n\n<!-- x-release-please-end -->\n\n### Running Locally\n\nAfter cloning the git repository for this project, you can use the\n`scripts/run` script to run the tool locally:\n\n```sh\n./scripts/run args...\n```\n\n## Usage\n\nThe CLI follows a resource-based command structure:\n\n```sh\nupbit [resource] <command> [flags...]\n```\n\n```sh\nupbit accounts list \\\n--access-key \"$UPBIT_ACCESS_KEY\" \\\n--secret-key \"$UPBIT_SECRET_KEY\"\n```\n\nFor details about specific commands, use the `--help` flag.\n\nFor more runnable examples, see the scripts in [`examples/`](examples/).\n\n### Environment variables\n\n| Environment variable | Description | Required | Default value |\n| -------------------- | ----------- | -------- | ------------- |\n| `UPBIT_ACCESS_KEY` | The access key provided by Upbit for API authentication. For more details, please refer to https://docs.upbit.com/reference/auth. | no | `null` |\n| `UPBIT_SECRET_KEY` | The secret key used to sign API requests for secure verification. For more details, please refer to https://docs.upbit.com/reference/auth. | no | `null` |\n\n### Global flags\n\n- `--access-key` - The access key provided by Upbit for API authentication.\n  For more details, please refer to https://docs.upbit.com/reference/auth.\n  (can also be set with `UPBIT_ACCESS_KEY` env var)\n- `--secret-key` - The secret key used to sign API requests for secure verification.\n  For more details, please refer to https://docs.upbit.com/reference/auth.\n  (can also be set with `UPBIT_SECRET_KEY` env var)\n- `--help` - Show command line usage\n- `--debug` - Enable debug logging (includes HTTP request/response details)\n- `--version`, `-v` - Show the CLI version\n- `--base-url` - Use a custom API backend URL\n- `--environment` - Select API environment (`kr`, `sg`, `id`, `th`)\n- `--format` - Change the output format (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--format-error` - Change the output format for errors (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--transform` - Transform the data output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n- `--transform-error` - Transform the error output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n\n## Linking different Go SDK versions\n\nYou can link the CLI against a different version of the Upbit Go SDK\nfor development purposes using the `./scripts/link` script.\n\nTo link to a specific version from a repository (version can be a branch,\ngit tag, or commit hash):\n\n```bash\n./scripts/link github.com/org/repo@version\n```\n\nTo link to a local copy of the SDK:\n\n```bash\n./scripts/link ../path/to/upbit-go\n```\n\nIf you run the link script without any arguments, it will default to `../upbit-go`.\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to CLI internals which are technically public but not intended or documented for external use.\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please contact us at open-api@upbit.com with questions, bugs, or suggestions.\n\n## Contributing\n\nThe Upbit CLI is in its initial release phase, and public contributions (Issues/PRs) are currently closed.\nFor bug reports and feedback, please email open-api@upbit.com.\nWe are considering opening external contribution channels in phases as this project becomes more stable.\n\n© 2026 Dunamu Inc. All rights reserved.\n","readmeFilename":"README.md"}