Skip to content

Commit

Permalink
Update README with recent additions
Browse files Browse the repository at this point in the history
  • Loading branch information
semperos committed Sep 4, 2024
1 parent 7669e36 commit 3e8c9ee
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Ari stands for **A**rray **R**elational **I**nteractive programming environment.

Ari is a set of extensions to the [Goal] programming language, also providing an extensible CLI with dedicated SQL mode.
Ari is a set of extensions to the [Goal] programming language with an extensible CLI and dedicated SQL mode.

## Installation

Expand All @@ -26,6 +26,7 @@ Then run `ari` for a REPL or `ari --help` to see CLI options.
- Runtime configuration:
- Configure the REPL prompt by setting string values for the `ari.prompt` and `ari.nextprompt` (for multiline input) globals
- Replace default REPL printing by setting a function value for the `ari.print` global (function receives a single Goal value to print)
- Configure the output format with `--output-format` or using one of the `)output.` system commands at the REPL. Formats include CSV/TSV, JSON, Markdown, and LaTeX.
- `ari.p` is bound to the previous result (value from last evaluation at the REPL)
- Extensible help system
- `help"help"` for an overview
Expand All @@ -37,7 +38,10 @@ Then run `ari` for a REPL or `ari --help` to see CLI options.
- New Goal functions:
- `http.` functions for HTTP requests using [Resty]
- `sql.` functions for SQL queries and commands
- Dedicated SQL mode for DuckDB
- _(WIP)_ `time.` functions for more extensive date/time handling
- `tui.` functions for basic terminal UI styling (colors, padding/margin, borders)
- Dedicated SQL mode
- The ari CLI uses DuckDB, but the `github.com/semperos/ari` Go package doesn't directly depend on a specific SQL database driver, so you can BYODB.
- Activate with `)sql` for read-only, `)sql!` for read/write modes. Execute `)goal` to return to the default Goal mode.
- Auto-completion of SQL keywords
- Help entries for SQL keywords (shown during auto-complete, still WIP)
Expand Down

0 comments on commit 3e8c9ee

Please sign in to comment.