README
Squid is a Shell and SSH terminal emulator, with end-to-end encryption for SSH Hosts in the cloud.
We use Electron and ReactJS. Everything is written in TypeScript.
Table of content
Downloading
Canary versions of Squid will be soon available for download in releases.
Please report any issues or new features you wish to see for Squid.
Documentation
Documentation is available at https://squidjs.github.io/docs;
Extending
The config file is located in your user's home directory, and called .squidrc.json
. Squid is higly customizable thanks to a powerful plugins system. With plugins, you can easily share and add custom themes, and add new features.
See the documentation for more information.
Cloud
You can save SSH Hosts in a remote server, to make them available on all the computers you use. They are then linked to your account on this server. The server is called Squid Cloud.
You can choose to use our server (this is the default configuration), or you can self-host it.
See the documentation for more information.
CLI
Squid ships with an easy-to-use CLI, used to start the app from any terminal and manage themes and plugins easily.
Run squid --help
for a list of available commands.
See the documentation for more information.
Contributing
First, make sure you have Yarn installed on your system.
You will need windows-build-tools
to compile the project. Install it globally (as an administrator) with:
- YARN:
yarn global add windows-build-tools
Then:
- Fork this repository, then clone it to your device
- Install JS dependencies with:
yarn
- Launch the development server and the app:
yarn dev
See CONTRIBUTING for more information.
Licence
Squid is licensed under the MIT license.