Release
This release was created from PR #8. If you encounter any bugs or have feedback about this release, please share your thoughts under that pull request.
Install
To get started with this release, you have two options:
- Download the appropriate release binary for your platform from the release assets below.
- Install it using Go: Run `go install github.com/cardano-community/koios-cli/[email protected] in your terminal.
Usage
To verify your installation and start using Koios CLI, follow these steps:
1. Check Installation
Run the following command to ensure Koios CLI is installed correctly:
$ koios-cli -h
# You should see help output:
2. Explore Commands
Koios CLI v2 offers detailed help menus for each command, including usage examples:
- Application Help Menu: Run
koios-cli -h
to view the main help menu. - API Calls: For information on available API calls, use
koios-cli api -h
. - Command Examples: Each command provides its own help menu with examples. For instance,
koios-cli api tip -h
shows usage for the tip command. - Manage Koios Subscription Tokens: Use
koios-cli auth -h
for token management options.
3. Authentication
- By default, all calls are made without an authorization header, so public tier limits apply. To use your own token, Koios CLI allows for one-time token usage with
koios-cli api --auth <subcommand>...
or the creation of local profiles using the koios-cli auth command.
Example:
1. To create a local profile with your token, the profile name will be derived from the projID
present in the JWT token you defined when creating your token.
$ koios-cli auth add <your-token>
2. Using profile(s) , you can sore as many tokens you want as far token projID
s are unique
koios-cli --profile <projID> api tip
To display your token usage stats you can use
api --stats
flag
koios-cli --profile <projID> api --stats tip
Please test Koios CLI v2.0.0-alpha.4 and share your feedback before PR #8 is merged and version 2.0.0 is released.
Changelog
Changelog
- 06ea506 fix: ensure that in prod profiles are stored correctly
- e422ade feat: prep v2.0.0-alpha.4
- 8914e4e sfix: update script_redeemers cmd
- 116143f sfix: update pool_relays cmd
- 5c93b96 sfix: update pool_metadata cmd
- 314c3d7 sfix: update plutus_script_list cmd
- 826f659 sfix: update native_script_list cmd
- 8a95290 sfix: update account_updates cmd
- df86e23 sfix: update account_rewards cmd
- c922f85 sfix: update account_list cmd
- e75eddd sfix: update account_info and account_info_cached
- f1b0906 sfeat: add script_info cmd
- 48dbb27 sfeat: add datum_info cmd
- e360a28 sfeat: add account_utxos cmd
- abe6cd9 sfeat: add account_txs cmd
- 0d24fbf sfeat: add Koios auth and auth profiles
- 17931fb fix: update tx_status cmd
- 7ac58d2 fix: update tx_metalabels cmd
- e7542be fix: update tx_metadata cmd
- 5a737ce fix: update tx_info cmd
- f9d660c fix: update pool_updates cmd
- dbecbab fix: update pool_stake_snapshot cmd
- 30fcf74 fix: update pool_list cmd
- 5f613b6 fix: update pool_history cmd
- b1f5f2d fix: update pool_delegators cmd
- fea2895 fix: update pool_blocks cmd
- b33e791 fix: update policy_asset_info cmd
- c7a7a4a fix: update [email protected]
- 6624548 fix: update github actions
- 9229c17 fix: update epoch_params cmd
- e1573a1 fix: update epoch_info cmd
- 4bc78e0 fix: update epoch_block_protocols
- b3c9a1f fix: update deps
- ced3aed fix: update dependencies
- ddd5d83 fix: update blocks command
- 84e87a7 fix: update block_txs
- ee09bae fix: update block_info cmd
- f190a7c fix: update asset_txs cmd
- 4800518 fix: update asset_summary
- 62c8665 fix: update asset_list command
- cc197aa fix: update asset_info cmd to produce asset list based on provided PolicyID.AssetName
- 88be3cd fix: update asset_history call
- 9fef99d fix: update api global flags
- e820a63 fix: update address assets schema
- 013224e fix: update account_assets cmd
- 9e904c1 fix: update account_addresses cmd
- 72dc392 fix: deprecate asset-address-list replaced by asset_addresses
- 9ab93ad feat: update pool_info cmd
- 74d05f4 feat: set address_info addresses as command args
- 4dfe54f feat: implement v1 address_info
- 877ebc6 feat: implement policy_asset_list endpoint
- 1b8fcc2 feat: implement policy_asset_list
- f80a1bd feat: implement policy_asset_addresses cmd
- 70d54f4 feat: implement credential_utxos command
- 0dcfe30 feat: implement credential_txs command
- 2d8bfae feat: implement asset_utxos
- 2b8e52d feat: implement asset_nft_address endpoint
- f1d621b feat: implement api address_txs cmd
- 4a7083b feat: implement address_assets endpoint
- 4f3621a feat: add utxo_info cmd
- 1aaa205 feat: add timout flag to adjust http client timeout
- 0cd0a41 feat: add subscription managment commands
- b98c66e feat: add script_utxos cmd
- 8a42435 feat: add pool_retirements cmd
- ca079b5 feat: add pool_registrations cmd
- 2c0d41d feat: add policy_asset_mints cmd
- bbd82e5 feat: add address_utxos command
- f1d5e47 feat: add Koios auth
- fac708f ci: update gihub actions
- eecbd78 chore: update docs for totals
- 3d86b24 fix: update release config to check for tag
- 7b05804 fix: update imports to v2
- 6228f16 fix: update deps
- 3477acb fix: update deps
- d6fda99 fix: remove version from install path
- 88278a8 docs: update readme