Readme
codama-cli
Command-line interface for generating Codama IDL from Rust projects.
Installation
cargo install -- path
Or build from source:
cargo build -- release - p
Usage
Generate IDL to stdout
codama-rs generate-idl ./my-program
Pretty-print the output
codama-rs generate-idl ./my-program -- pretty
Save to file
codama-rs generate-idl ./my-program - o
Combine flags
codama-rs generate-idl ./my-program -- pretty -- output
Command Reference
Command- line interface for Codama
Usage: codama- rs < COMMAND >
Commands:
generate- idl Generate IDL from a Rust project
help Print this message or the help of the given subcommand ( s)
Options:
- h, - - help Print help
- V, - - version Print version
generate-idl Generate IDL from a Rust project
Usage: codama- rs generate- idl [ OPTIONS ] [ PATH ]
Arguments:
[ PATH ] Path to the Rust project ( defaults to current directory) [ default: . ]
Options:
- o, - - output < OUTPUT > Output file path ( defaults to stdout)
- p, - - pretty Pretty- print the JSON output
- h, - - help Print help
Examples
Example 1: Generate from current directory
cd my-solana-program
codama-rs generate-idl
codama-rs generate-idl ./programs/my-program -- pretty
Output:
{
" kind" : " rootNode" ,
" standard" : " codama" ,
" program" : {
" kind" : " programNode" ,
" name" : " myProgram" ,
. . .
}
}
Example 3: Save to file for processing
codama-rs generate-idl ./my-program - o
# IDL written to: idl.json
Requirements
Rust toolchain
A Rust project with a valid Cargo.toml
License
Apache-2.0