Skip to content

cedar-policy-cli

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

cedar-policy-cli

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
sample-data
sample-data
 
 
src
src
 
 
tests
tests
 
 
CHANGELOG.md
CHANGELOG.md
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 
THIRD_PARTY_LICENSES.txt
THIRD_PARTY_LICENSES.txt
 
 

README.md

Cedar CLI

This package contains the Command Line Interface (CLI) for Cedar.

For more information about the Cedar language/project, please take a look at cedarpolicy.com. See also the cedar-policy package, which is the main public Rust API for Cedar.

This app uses the annotation @id("PID") as a simple way to define policy ids. This usage is not standard and annotations have custom use depending on the app.

Install

Pre-built binaries

Pre-built cedar binaries are attached to each GitHub release tagged cedar-policy-cli-v* for:

  • Linux: x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu
  • macOS: x86_64-apple-darwin, aarch64-apple-darwin
  • Windows: x86_64-pc-windows-msvc

Archives bundle the cedar binary, LICENSE, NOTICE, and THIRD_PARTY_LICENSES.txt with sha256 sums; the release page also provides one-line curl | sh (POSIX) and irm | iex (PowerShell) installer scripts.

These are default-feature builds. The tpe and symcc subcommands are in the experimental flavor below; partially-authorize and the --validation-mode permissive/partial flags are not shipped — build from source if you need them.

Experimental flavor

A parallel cedar-policy-cli-experimental-<target>.<ext> archive is attached to every release. Same cedar binary name, built with tpe and analyze enabled. The analyze feature exposes cedar symcc ... subcommands for symbolic verification of policies; using them additionally requires the external cvc5 SMT solver installed at runtime. Surface area of these features can change between releases; use the regular flavor if stability matters.

From source

You will need to install Rust, via rustup.

To install the CLI, run cargo install cedar-policy-cli.

Build

You will need to install Rust, via rustup.

To build the CLI, run cargo build or cargo build --release.

Run

Run cargo run -- --help to list the available CLI commands.

The sample-data folder contains examples for the CLI. Refer to the instructions in each README.md to run the examples.

What's New

Changelogs for all release branches and the main branch of this repository are all maintained on the main branch; the most up-to-date changelog for this crate is here.

For a list of the current and past releases, see crates.io or Releases.

Security

See SECURITY for more information.

Contributing

We welcome contributions from the community. Please either file an issue, or see CONTRIBUTING

License

This project is licensed under the Apache-2.0 License. Pre-built archives bundle NOTICE and THIRD_PARTY_LICENSES.txt; cedar license prints the same attributions.