GithubHelp home page GithubHelp logo

Comments (2)

tsandall avatar tsandall commented on April 27, 2024

Tempted to add an "Examples" section to the 'help' message. For example:

$ opa run *.json
OPA 0.2.1-dev (commit f56ae0d, built at 2016-11-14T22:38:16Z)

Run 'help' to see examples and list of commands.

> help

Examples
========

> data           # show all data and evaluate all rules
> data[x] = _    # show top-level keys
> data.foo.bar   # show specific value

Commands
========

        <stmt> : evaluate the statement
package <term> : change currently active package
 import <term> : add import to currently active module
   unset <var> : undefine rules in currently active module
          json : set output format to JSON
        pretty : set output format to pretty
   dump [path] : dump the raw storage content
         trace : toggle full trace
         truth : toggle truth explanation
          help : print this message
          exit : exit back to shell (or ctrl+c, ctrl+d)
        ctrl+l : clear the screen

from opa.

timothyhinrichs avatar timothyhinrichs commented on April 27, 2024

I like that, though people might want examples for things besides lookup. And then the examples section might large. But perhaps that's a bridge we'll cross when we get to it.

from opa.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.