README
¶
SuperTXT Integrations
This is a collection of SuperTXT integrations with tools, utilities, and libraries to work with the medium.
Browsing Shell (brsh)
Browsing Shell is a graphical version of the standard Unix shell (sh). You can install it like this:
git clone nobody@supertxt.net:git/st-int
cd st-int
go install ./cmd/brsh
There is help available in the shell through the "help" command.
Search (srch)
The search tool analyzes, indexes, and searches for file content on your machine with built-in support for SuperTXT content and semantics. As an SSHLA compatible tool it can also search remote paths using SSH, much like scp, or git.
git clone nobody@supertxt.net:git/st-int
cd st-int
go install ./cmd/srch
Search for some text in a SuperTXT file in your home directory like this:
srch <<EOF
my todo list
EOF
Read more about how to use "srch" in the README.
Wikipedia Site-Specific Command
This site-specific command opens up the world of wikipedia to the command-line and rich client application world. You can perform searches and view documents in a text-friendly way. Here's a simple text search of the site:
wikipedia.org srch <<EOF
space opera
EOF
You can view an article by name and file extension like this:
wikipedia.org cats Toronto.s.txt
This command, once installed on your path, plugs into both the "cats" command-line tool and "srch" so that wikipedia behaves like any other SSH server. The above two commands could be written like this instead so that they work in reflective environments, like the browsing shell. Here is the simple search:
srch -C wikipedia.org: <<EOF
space opera
EOF
This loads the article by name and file extension:
cats wikipedia.org:Toronto.s.txt
Install the wikipedia SSC like this:
git clone nobody@supertxt.net:git/st-int
cd st-int
go install ./cmd/wikipedia.org
Find more information about this site specific tool with the "--help" flag.
Conserv SSH server
The conserv server is a light-weight SSH server that specializes in content sharing instead of infrastructure access.
You can pick an empty directory to start. The server generates a key, content directory, and wrapper scripts for commands.
cd mydir
conserv hostkey
The server is accessible via ssh on port 2222.
ssh -p 2222 localhost
Install conserv like this:
git clone nobody@supertxt.net:git/st-int
cd st-int
go install ./cmd/conserv
Deserv http server
The deserv server serves conserv content over http for regular web browsers. You can run it from the same directory as conserv.
cd mydir
deserv
Navigate to the website at localhost:5050
Install deserv like this:
git clone nobody@supertxt.net:git/st-int
cd st-int
go install ./cmd/deserv
Lexical Parser
A simple SuperTXT parser can be found in the "parser" package.
Viewers
A set of SuperTXT and other related viewers can be found in the "viewer" package built on the GioUI framework.
Ask Password
Ask password is a GIO UI framework for graphical prompting for SSH credentials and prompts.
Progress Reporting
Following the reporting progress specification this package helps to produce progress reports and parse those reports from stderr.
Command Builder
This is a framework for assembling logical commands composed of both OS executables and built-ins with support for piping them and running them together using a subset of the Unix sh syntax.
Runner
Provides a GIO UI command-line prompt and produces viewers for a command's stdout and stderr for displaying in a graphical application.
Legal
See the license for more information.
Directories