Have you ever wondered "what if a website worked like a Unix terminal"? With ClIte, now you know.
Go to file
Lisa Milne c674ca0015 documentation and version bump 2023-12-03 18:16:35 +10:00
clite documentation and version bump 2023-12-03 18:16:35 +10:00
data update documents and bump version 2023-11-27 20:37:45 +10:00
index.html terminal scrolling headaches 2023-11-07 21:11:28 +10:00
readme-internals.txt update documents and bump version 2023-11-27 20:37:45 +10:00
readme-libs.txt version bump, documentation update 2023-12-02 18:33:58 +10:00
readme-programs.txt update documents and bump version 2023-11-27 20:37:45 +10:00
readme.txt documentation and version bump 2023-12-03 18:16:35 +10:00


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 GNU Affero General Public License, V3.
 Though this may change.

A functioning test instance of CLIte is available at
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

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)

mkdir	- make a directory

Under Development:
view	- file viewer, should display files something like the way a
	text mode browser would, so is for actually viewing the website

Running any command with the argument -? will give you help for that

The shell supports argument 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
 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 not currently supported, 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
	- with argument: allows an environment variable to be changed or
		created. `export FOO=bar'

For more information, check the other readme files for info on CLIte internals.
Also, consider buying the developer a coffee: