diff --git a/README.md b/README.md index c2834767..8a675efc 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,32 @@ For now the command line application can only encode/decode Untyped Plutus Core to/from it's on chain format. See the roadmap below for a list of planned features and goals. ```sh -# compile an untyped plutus core program +# help +aiken help + +# compile an untyped plutus core program to flat aiken uplc flat program.uplc + +aiken uplc flat program.uplc --print + +# output +00001011 00010110 00100001 01001000 +00000101 10000001 + +aiken uplc flat program.uplc --out=something.flat + +# decode an untyped plutus core program from flat +aiken uplc unflat program.flat + +aiken uplc unflat program.flat --print + +# output +(program + 11.22.33 + (con integer 11) +) + +aiken uplc unflat program.flat --out=something.uplc ``` ## Roadmap diff --git a/crates/cli/src/args.rs b/crates/cli/src/args.rs index 543a397b..31c4e588 100644 --- a/crates/cli/src/args.rs +++ b/crates/cli/src/args.rs @@ -4,7 +4,7 @@ use clap::{Parser, Subcommand}; /// Cardano smart contract toolchain #[derive(Parser)] -#[clap(author, version, about, long_about = None)] +#[clap(version, about, long_about = None)] #[clap(propagate_version = true)] pub enum Args { /// A subcommand for working with Untyped Plutus Core @@ -31,9 +31,8 @@ pub enum UplcCommand { #[clap(short, long)] out: Option, }, - Fmt { - input: PathBuf, - }, + /// Format an Untyped Plutus Core program + Fmt { input: PathBuf }, } impl Default for Args {