{"id":41282643,"url":"https://github.com/clearmatics/ion-cli","last_synced_at":"2026-01-23T02:54:25.559Z","repository":{"id":57616714,"uuid":"222975079","full_name":"clearmatics/ion-cli","owner":"clearmatics","description":"Command line interface for Ion Protocol","archived":false,"fork":false,"pushed_at":"2020-04-07T17:57:04.000Z","size":323,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-03-13T22:35:12.270Z","etag":null,"topics":["clearmatics-engineering"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clearmatics.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}},"created_at":"2019-11-20T16:00:19.000Z","updated_at":"2023-10-10T07:35:12.000Z","dependencies_parsed_at":"2022-08-27T08:22:21.867Z","dependency_job_id":null,"html_url":"https://github.com/clearmatics/ion-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/clearmatics/ion-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearmatics%2Fion-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearmatics%2Fion-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearmatics%2Fion-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearmatics%2Fion-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clearmatics","download_url":"https://codeload.github.com/clearmatics/ion-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clearmatics%2Fion-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28679139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T01:00:35.747Z","status":"online","status_checked_at":"2026-01-23T02:00:08.296Z","response_time":59,"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":["clearmatics-engineering"],"created_at":"2026-01-23T02:54:24.854Z","updated_at":"2026-01-23T02:54:25.554Z","avatar_url":"https://github.com/clearmatics.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ion CLI\n\nThe Command-Line Interface reference.\n\n## Building the CLI\n\nClean the directory: `make clean`.\n\n### Requirements\n\n* [`solc`](https://github.com/ethereum/solidity/releases) ensure matching compiler version with target solidity code as 0.4.x will not be compatible with solc 0.5\n\nRun `make build` to fetch sources and compile the binary. This will error if attempted to be built outside of your `GOPATH`.\n\n## Usage\n\nRun `./ion-cli` to launch the interface.\n\n```\naddAccount                  use:   addAccount [name] [path/to/keystore]\n                            description: Add account to be used for transactions\n\nAdds an account to be referenced by given name that can be used to sign transactions from. Takes a name\n(string) that can be any chosen name, and a path to a keystore file containing an encrypted private key.\n\nAccounts are not persisted between sessions.\n```\n```\naddContractInstance         use:   addContractInstance [name] [path/to/solidity/contract]\n                            description: Compiles a contract for use\n\nAdds a compiled contract instance. This contract instance can be deployed to a connected chain or used\nto make function calls to deployed contracts. Takes any chosen name (string) and a path to the Solidity\ncontract to be compiled.\n\nContracts are not persisted between sessions.\n```\n```\nclear                       clear the screen\n```\n```\nconnectToClient             use:   connectToClient [rpc url]\n                            description: Connects to an RPC client to be used\n\nConnects to an Ethereum blockchain specified by a given url. This chain will be used for contract\ndeployment, calls, chain data etc. unless specified otherwise.\n\nOnly one client can be connected at a time.\n```\n```\ndeployContract              use:   deployContract [contract name] [account name] [gas limit]\n                            description: Deploys specified contract instance to connected client\n\nDeploys a specified compiled contract instance by name from the specified account name to the connected\nclient. Requires gas limit to be provided.\n```\n```\nexit                        exit the program\n```\n```\ngetBlockByHash              use:   getBlockByHash [optional rpc url] [hash]\n                            description: Returns block header specified by hash from connected client\n                            or from specific endpoint\n\nRetrieves the block header from the connected or specified endpoint at given block hash.\n```\n```\ngetBlockByHash_Clique       use:   getBlockByHash_Clique [optional rpc url] [hash]\n                            description: Returns signed and unsigned RLP-encoded block headers by\n                            block hash required for submission to Clique validation connected\n                            client or specified endpoint\n\nRetrieves RLP-encoded block headers that have been signed and unsigned by validators of the Clique\nmechanism specified by block hash. This is used to be submitted to the Clique validation contract\nscheme for interoperation with Clique proof-of-authority chains.\n```\n```\ngetBlockByNumber            use:   getBlockByNumber [optional rpc url] [integer]\n                            description: Returns block header specified by height from connected\n                            client or from specified endpoint\n\nRetrieves the block header from the connected or specified endpoint at given block number.\n```\n```\ngetBlockByNumber_Clique     use:   getBlockByNumber_Clique [optional rpc url] [integer]\n                            description: Returns signed and unsigned RLP-encoded block headers by\n                            block number required for submission to Clique validation from connected\n                            client or specified endpoint\n\nRetrieves RLP-encoded block headers that have been signed and unsigned by validators of the Clique\nmechanism specified by block number. This is used to be submitted to the Clique validation contract\nscheme for interoperation with Clique proof-of-authority chains.\n```\n```\ngetProof                    use:   getProof [optional rpc url] [Transaction Hash]\n                            description: Returns a merkle patricia proof of a specific transaction\n                            and its receipt in a block\n\nRetrieves a merkle patricia trie proof of a transaction in a block. It checks against the Transaction\nTrie and the Receipt Trie in a block, reconstructs the trie and generates a proof that the specified\ntransaction exists in the trie and returns the data to verify the proof.\n```\n```\ngetTransactionByHash        use:   getTransactionByHash [optional rpc url] [hash]\n                            description: Returns transaction specified by hash from connected\n                            client or specified endpoint\n\nRetrieves the transaction data of a specified transaction by hash.\n```\n```\nhelp                        display help\n```\n```\nlinkAndDeployContract       use:   deployContract [contract name] [account name] [gas limit]\n                            description: Deploys specified contract instance to connected client\n\nLinks any required libraries to a contract instance before deploying to the connect client.\n```\n```\nlistAccounts                use:   listAccounts\n                            description: List all added accounts\n\nLists all added accounts.\n```\n```\nlistContracts               use:   listContracts\n                            description: List compiled contract instances\n\nLists all added contract instances.\n```\n```\ntransactionMessage          use:   transactionMessage [contract name] [function name] [from account name] [deployed contract address] [amount] [gasLimit]\n                            description: Calls a contract function as a transaction.\n\nCalls a contract instance function that has been deployed to the connected client as a transaction. This\nwill mutate the world state of the destination chain if the transaction is accepted into a block.\nRequires gas.\n\nWill be prompted to provide function input parameters.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearmatics%2Fion-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclearmatics%2Fion-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearmatics%2Fion-cli/lists"}