![\"Example](\"./assets/bunq-cli-3.gif\")
\n\n \n
Interactive mode example
\n\n## Features\n\n- Create and add funds to sandbox accounts within seconds\n- Create a new monetary account from the command line\n- Send API requests and output to console or files as JSON\n\n## Getting started\n\nInstall globally as a command `yarn global add @bunq-community/bunq-cli` or `npm install -g @bunq-community/bunq-cli`\n\nStandard interactive mode while storing your keys at the default location:\n\n```bash\nbunq-cli --save\n```\n\n## Roadmap\n - Add a password option to allow for production API key storage\n - Turn commands and actions into a module-like system\n - Support for both regular API key and OAuth logins through QR codes.\n - View current user, monetary accounts and other API data in interactive mode.\n - Transfers between own accounts by ID and description for CLI mode and through the UI in interactive mode.\n - `bunq-cli --cli --transfer --transfer-from Shopping --transfer-to Savings --amount 10`\n - `bunq-cli --cli --transfer --transfer-from-id 1234 --transfer-to-id 4321 --amount='12.36' --description='Less shopping'`\n\n## Options\n\nbunq-cli will check for a .env in your working directory. Any environment variables starting with `BUNQ_CLI_` will be parsed as input options. Some examples of this are:\n\n- `BUNQ_CLI_API_KEY=some-key-value` instead of `--api-key`\n- `BUNQ_CLI_SAVE=false` instead of `--save=false`\n\nMake sure to use `--help` to view the specific options you can use for each sub command\n\n### Generic options\n\nThese are the most basic options that you'll need. If `--memory` is defined, the bunqJSClient will do everything in memory without writing data to a file. Subsequent API calls will be faster if you do not use this option since it won't have to setup a new API session with bunq the next time you use bunq-cli.\n\n- `--save`/`-s` Location to store the API session info, defaults to `$HOME/bunq-cli.json`. Use the --memory option to ignore stored data.\n- `--memory` Ignores the stored session info and does everything in memory, useful for testing sandbox scripts without removing the stored key.\n- `--overwrite` Overwrite the stored session info with the given options, by default this is false so parameters like `--api-key` are ignored if session info already exists.\n- `--output` How to output the API data. Choices are `file`/`f` for writing a new file to the output-location or `console`/`c` in CLI mode to output only the API data to the console.\n- `--output-location` Directory location if `--output` is set to file. Defaults to `$HOME/bunq-cli-api-data`.\n\n- `--apiKey`/`--apiKey` The bunq API key, creates a sandbox key by default\n- `--deviceName`/`--device-name` Device name to identify the API key\n- `--encryptionKey`/`--encryption-key` Encryption key for bunqJSClient, generates a random key by default\n- `--environment` bunq API environment to use\n\n### Optional parameters\n\n- `--method` API method to use, defaults to \"LIST\".\n- `--data` A string with JSON which is the data that well be sent in POST/PUT requests.\n- `--count`, `--older-id` and `--newer-id` for filtering LIST requests like described in the bunq docs.\n- `--account` To define which MonetaryAccount should be used by account description.\n- `--accountId`/`--account-id` To define which MonetaryAccount should be used by account ID.\n- `--account` To define which MonetaryAccount should be used by account description.\n- `--eventId`/`--event-id` To define which object should be fetched, required for most GET endpoints.\n- `--pretty` Whether to prettify the JSON output or not. You can give it a string to use as spacer, defaults to 2 spaces, use '\\t' to format with tabs for example\n- `--clean` Will attempt to cleanup some of the wrappers for the bunq API. For example Arrays with a single value or the Response object.\n\n## Sub commands\n\nBy default the `--output` mode is set to `console` when using sub commands.\n\n### Basic commands\n\n- `bunq-cli user` Fetches the User info.\n- `bunq-cli accounts` Fetches all monetary accounts for the current User.\n- `bunq-cli events` Fetches all events using the `/user/{userId}/event` endpoint.\n- `bunq-cli create-key` Creates a new Sandbox environment API key and outputs it.\n\n## Advanced commands\n\nThese commands require more knowledge of the API but supply a few useful ways to make using the correct endpoints and accounts easier.\n\n- `bunq-cli endpoint