Searchex v0.0.1 Searchex.Render

CLI rendering : tables and editor launch

  • editor launching
  • rendering search-results as a table
  • mini-views for build steps

Summary

Functions

Return processing summary for build. (Catalog + Index)

Return processing summary for catalog generation

Remove the cache file for a collection

Edit a document

Return processing summary for index generation

Show statistics for all collections

Invoke Searchex.Command.modify, then launch an editor to open the config file

Invoke Searchex.Command.query, then render the results as a table

Invoke Searchex.Command.results, then render the results to a table

Show document text

Functions

build(cfg_snip)

Return processing summary for build. (Catalog + Index)

catalog(cfg_snip)

Return processing summary for catalog generation.

clean(cfg_snip)

Remove the cache file for a collection.

edit(cfg_snip, tgt_id)

Edit a document.

For files which contain multiple documents, this command attempts to launch the editor on the right line.

NOTE: you must define environment variables EDITOR. This will only work with TMUX

Editor-launch in Elixir needs fixing. See this thread for more info: https://elixirforum.com/t/how-to-launch-an-editor-from-escript/2094/1

index(cfg_snip)

Return processing summary for index generation.

info()

Show statistics for all collections.

modify(cfg_snip)

Invoke Searchex.Command.modify, then launch an editor to open the config file.

NOTE: you must define environment variables EDITOR. This will only work with TMUX

Editor-launch in Elixir needs fixing. See this thread for more info: https://elixirforum.com/t/how-to-launch-an-editor-from-escript/2094/1

query(cfg_snip, query)

Invoke Searchex.Command.query, then render the results as a table.

results(cfg_snip)

Invoke Searchex.Command.results, then render the results to a table.

show(cfg_snip, tgt_id)

Show document text.