Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corporate-runaways/tooloo
Command LookUp
https://github.com/corporate-runaways/tooloo
hacktoberfest raku rakulang
Last synced: 3 months ago
JSON representation
Command LookUp
- Host: GitHub
- URL: https://github.com/corporate-runaways/tooloo
- Owner: corporate-runaways
- License: other
- Created: 2022-08-27T18:05:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-17T23:12:21.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T20:41:33.360Z (3 months ago)
- Topics: hacktoberfest, raku, rakulang
- Language: Raku
- Homepage:
- Size: 1.34 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# TooLoo
Got an overwhelming number of command line scripts and functions? So
many you\'ve actually started to forget what options you have available,
or what some of them do? Try TooLoo!
# What does it do?
TooLoo allows provides a [full text search](https://en.wikipedia.org/wiki/Full-text_search) of the name, description, and details of your scripts. When a script includes a \"help\" command, TooLoo will call it and display current usage docs instead of potentially outdated ones from its cache.
Scroll down to see some examples of its output.
Additionally, TooLoo can generate a static web site with a built-in [Lunr](https://lunrjs.com/) search to document all your commands. To accomplish this, TooLoo generates the Markdown files, and [Hugo](https://gohugo.io/) builds the search index, and converts it to a site for you.
# Usage
``` example
Usage:
tooloo -V|--version[=Any] [--verbose[=Any]]
tooloo add -- Add & updates documentation of a command with a .toml file, or an ansiicast demo with a .cast file
tooloo add-many -- Add / update all .toml & .cast files in a directory or its children.
tooloo demo -- play the asciicast demo of the specified command
tooloo demos -- List all your commands that have associated asciicast demos
tooloo find [ ...] -- Execute a full text against documented commands. Search terms should be separate arguments.
tooloo list -- List all your commands & their quick description
tooloo list -- Lists a filtered subset of commands via filter: 'demos'
tooloo list-json
tooloo export -- Create a static blog documenting all your commands
tooloo remove -- Remove a command from the database
tooloo serve [] -- Starts a mini JSON REST server (will lock the db)
tooloo show -- Display the full details of a specific command
tooloo show-json
tooloo template -- Generate a blank TOML template alongside the specified command
tooloo update -- Updates documentation of a command with a .toml file, or an ansiicast demo with a .cast file
Paths must end in .toml or .cast
Path to dir to search for .toml & .cast files
Currently supported filters: demos
Currently supported formats: hugo
the directory to export to
Hostname or IP address to bind to (0.0.0.0 / localhost)
[] port to use, defaults to 6996 [default: 6996]
The name of the executable
```
# Want All The Docs?
[TooLoo.dev](https://tooloo.dev) has got you covered.
I\'m a big fan of README Driven Development, but this README was getting
to be too much for one page.