ShellCanvas documentation

ShellCanvas gives a headless machine a graphical workspace — files, a terminal, a text editor and apps — running on the computer in front of you, over an ordinary SSH connection. Nothing is installed on the machine you connect to.

New here? Read What is ShellCanvas?, then install it and make your first connection. Building something on top of it? The App SDK quickstart and the adapter quickstart are the two starting points.

ShellCanvas is an early prototype, and these guides are written accordingly: they describe what the current release does, name the platform each feature is verified on, and say plainly where something is planned rather than built. Compatibility and known limitations collects those boundaries in one place.

Getting started

Understand the product and open your first workspace.

• What is ShellCanvas?
• Installation and builds
• Requirements and compatibility
• Your first connection
• The desktop at a glance
• Hosts, connections and workspaces

User guide

Everyday workflows on local and remote systems.

• Saved hosts and SSH config
• Workspaces and profiles
• Browse and manage files
• Upload, download and copy
• Terminal sessions
• Edit and save remote files
• Local drives and mounted filesystems
• Disconnect and reconnect
• Appearance and app settings
• Remote host settings
• Keyboard shortcuts

Apps and customization

Install, configure and develop extensions.

• Install and update apps
• Canvas Assistant
• Create and install themes
• Extension permissions and trust

App SDK

Build apps against the public TypeScript API.

• Build your first app
• Manifests and packaging
• App lifecycle and services
• Files API
• Transfers API
• Console API
• Storage API
• Network and credentials API
• Clipboard API
• Window API
• System dialogs API
• Events and environment API
• Host settings API
• Custom services

Adapters and filesystems

Connect other devices and filesystem providers.

• Build your first adapter
• Adapter process protocol
• Adapter packages
• Adapter services
• Filesystem contracts and SDK
• Adapter diagnostics

Architecture

Understand the implementation and its boundaries.

• System architecture
• Connection and workspace model
• Trust and isolation model
• Providers and device detection
• Build, test and contribute

Troubleshooting

Diagnose problems and understand current limits.

• Connection and host-key problems
• File, save and transfer problems
• App installation and permissions
• Compatibility and known limitations
• Report a reproducible issue