feat: support -h\--help option (#21)

1 file changed
tree: 48a61c6a42ccf154a44c5c44b9b3a50923b41b5b
  1. .github/
  2. examples/
  3. src/
  4. .gitignore
  5. .releaserc.json
  6. casbin
  7. casbin.cmd
  8. LICENSE
  9. pom.xml
  10. README.md
README.md

casbin-java-cli

casbin-java-cli is a command-line tool based on jcasbin, enabling you to use all of jcasbin's APIs in the shell.

Installation

  1. Clone project from repository
git clone https://github.com/jcasbin/casbin-java-cli.git
  1. Build project, the jar package will be generated in the target directory
cd casbin-java-cli
mvn clean install

Options

optionsdescriptionmustremark
-m, --modelThe path of the model file or model textyPlease wrap it with "" and separate each line with |
-p, --policyThe path of the policy file or policy textyPlease wrap it with "" and separate each line with |
-e, --enforceCheck permissionsnPlease wrap it with ""
-ex, --enforceExCheck permissions and get which policy it isnPlease wrap it with ""
-AF, --addFuntionAdd custom funtionnPlease wrap it with "" and separate each line with |
-ap, --addPolicyAdd a policy rule to the policy filenPlease wrap it with ""
-rp, --removePolicyRemove a policy rule from the policy filenPlease wrap it with ""

Get started

  • Check whether Alice has read permission on data1

    ./casbin enforce -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data1" "read"
    

    {“allow”:true,“explain”:null}

    ./casbin enforce -m "[request_definition]|r = sub, obj, act|[policy_definition]|p = sub, obj, act|[role_definition]|g = _, _|[policy_effect]|e = some(where (p.eft == allow))|[matchers]|m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act" -p "p, alice, data1, read|p, bob, data2, write|p, data2_admin, data2, read|p, data2_admin, data2, write|g, alice, data2_admin" "alice" "data1" "read"
    

    {“allow”:true,“explain”:null}

  • Check whether Alice has write permission for data2. If so, display the effective policy.

    ./casbin enforceEx -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data2" "write"
    

    {“allow”:true,“explain”:[“data2_admin”,“data2”,“write”]}

  • Add a policy to the policy file

    ./casbin addPolicy -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data2" "write"
    

    {“allow”:true,“explain”:null}

  • Delete a policy from the policy file

    ./casbin removePolicy -m "examples/rbac_model.conf" -p "examples/rbac_policy.csv" "alice" "data2" "write"
    

    {“allow”:true,“explain”:null}