https://github.com/squidjs/terminal

The extendible Shell and SSH terminal, with E2E encryption in the cloud.
https://github.com/squidjs/terminal

cloud electron shell squid ssh terminal

Last synced: about 2 months ago
JSON representation

The extendible Shell and SSH terminal, with E2E encryption in the cloud.

• Host: GitHub
• URL: https://github.com/squidjs/terminal
• Owner: squidjs
• License: mit
• Archived: true
• Created: 2019-08-08T10:01:42.000Z (almost 5 years ago)
• Default Branch: canary
• Last Pushed: 2022-07-21T03:02:40.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T04:16:17.480Z (about 2 months ago)
• Topics: cloud, electron, shell, squid, ssh, terminal
• Language: TypeScript
• Homepage: https://squid.js.org
• Size: 3.82 MB
• Stars: 29
• Watchers: 3
• Forks: 0
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-stars - squidjs/terminal - The extendible Shell and SSH terminal, with E2E encryption in the cloud. (TypeScript)
• awesome-github-star - terminal

README

        


    





    

        

    

    

        

    

    

        

    



**Squid** is a Shell and SSH terminal emulator, with **end-to-end encryption** for SSH Hosts in the [cloud](#cloud).

We use [Electron](https://electronjs.org) and [ReactJS](https://reactjs.org). Everything is written in [TypeScript](https://typescriptlang.org).



    



## Table of content

- [Downloading](#downloading)

- [Documentation](#documentation)

- [Extending the app](#extending)

- [Save SSH Hosts to the cloud](#cloud)

- [CLI](#cli)

- [Contributing](#contributing)

- [Licence](#licence)

## Downloading

**Canary** versions of Squid will be soon available for download in [releases](https://github.com/QuiiBz/squid/releases).

Please report any issues or new features you wish to see for Squid.

## Documentation

Documentation is available at [https://squidjs.github.io/docs](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 **packages** system. With packages, you can easily share and add custom **themes** and **packages** to add new features.

See the [documentation](https://squidjs.github.io/docs/configuration) 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](https://github.com/squidjs/cloud).

You can choose to use our server (this is the default configuration), or you can **self-host** it.

See the [documentation](https://squidjs.github.io/docs/cloud) for more information.

## CLI

Squid ships with an easy-to-use CLI, used to start the app from any terminal and manage packages easily.

Run `squid --help` for a list of available commands.

See the [documentation](https://squidjs.github.io/docs/cli) 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:

1) Fork this repository, then clone it to your device

2) Install JS dependencies with:

- `yarn`

3) Launch the development server and the app:

- `yarn dev`

See [CONTRIBUTING](CONTRIBUTING.md) for more information.

## Licence

Squid is licensed under the [MIT](https://choosealicense.com/licenses/mit/) license.