CLIte/readme.txt
2025-09-02 20:26:42 +10:00

93 lines
3.2 KiB
Text

Welcome to CLIte (pronounced like 'site' with an added L, or like 'slight').
CLIte is an experimental javascript project based on answering the
question no one asked: "What if a website worked like a Unix Terminal?"
CLIte is licensed under the "3 clause BSD" style license, which may be
viewed in license.txt or at /etc/license inside a running CLIte system.
A functioning test instance of CLIte is available at
http://www.ltmnet.com/clite/index.html
CLite has also been designed, with some work-arounds and bugs, to work
locally without a web server. Just download or clone the git repository
locally and open index.html in your browser.
The following commands are currently available in the CLIte shell:
help - a simple help command for new users, gives a basic introduction
to "What do I do now?"
ls - list directory contents, accepts the -l argument for showing
output in long form, with more detail.
cat - prints files to either the terminal, or with the -d argument
to the local device (downloads the file)
touch - create a new file, or load a file's remote data
less - simple text file viewer, up and down arrows will scroll the
text, q or escape to exit
file - determines the file type
sh - the CLIte shell
reboot - reboots the system, this will force-reload all javascript, so
helps get around issues with browser cache
uname - prints system information
vi - visual text editor (very much a wip, very buggy)
rm - remove files
chmod - change file modes (permissions)
chown - change file ownership
su - switch user accounts
mkdir - make a directory
date - view the current system date
user - user account manager
passwd - change user passwords
cc - code compiler
Running any command with the argument -? will give you help for that
program.
The shell supports arguments in "quotes" and 'single quotes', as well as
$VARIABLES (environment variables include PATH, USER, PWD, and HOME).
Support for `command substitution` is in progress.
Some tabfill support is functional, but more work is needed to tabfill
paths.
Shell paths support tilde (~) for the user's home directory, as well as
dot (.) and dot dot (..) for current and parent directories. The
asterisk (*) wildcard is not currently supported
The shell maintains a command history, use up and down arrows to access.
Piping and io redirects are supported, however they may be buggy.
Minimal shell scripting is supported: no loop support (yet).
The following shell builtin commands or macros are available:
clear - clears the terminal window
cd - changes the present working directory
pwd - prints the present working directory (equivalent to `echo $PWD')
echo - prints text or variables
which - prints the full path of a command: `which ls' - > "ls is /bin/ls"
type - similar to which, but also tells if a command is a shell builtin
whoami - prints the current username (equivalent to `echo $USER')
export - without arguments: will print all environment variables and their
values.
- with argument: allows an environment variable to be changed or
created. `export FOO=bar'
if / then / else / fi works as per posix (mostly)
For more information, check the other readme files for info on CLIte internals.
Also, consider buying the developer a coffee:
https://ko-fi.com/ticklishhoneybee