ShellCanvas

KO | EN

gitlite — search

#swift #list #agent #chatgpt #tailwindcss #java #css #self-hosted #javascript #kotlin

(★ 9)

A beautiful, extensible desktop for remote devices. SSH first, composable connections by design.

File Explorer

ZIP Download

- - ci.yml
  - publish-sdks.yml
  - release-desktop-platform.yml
  - release-windows.yml
- icon.svg
- - Cargo.toml
- - Cargo.toml
  - LICENSE
  - README.md
- - Cargo.toml
  - LICENSE
  - README.md
- - Cargo.toml
- - Cargo.toml
- - theme.schema.json
- adapter-diagnostics.md
- adapter-packages.md
- adapter-process.md
- adapter-sdk.md
- ai-development-skills.md
- ai-integration.md
- app-clipboard.md
- app-console.md
- app-events.md
- app-files.md
- app-host-settings.md
- app-network.md
- app-sdk.md
- app-services.md
- app-storage.md
- app-transfers.md
- app-window.md
- apps.md
- architecture.md
- assistant-goal.md
- client-platform-compatibility.md
- connection-lifecycle.md
- connection-recovery.md
- connection-ui-validation.md
- connections.md
- core-completion.md
- core-workflows.md
- custom-services.md
- desktop-clock.md
- desktop-updates.md
- device-detection.md
- drives-and-mounts.md
- file-actions.md
- file-clipboard.md
- file-navigation.md
- filesystem-contract.md
- filesystem-integration-progress.md
- home-assistant.md
- host-profiles.md
- kernel-acceptance.md
- kernel-history.md
- kernel-roadmap.md
- live-file-clipboard-validation.md
- live-image-clipboard-validation.md
- local-drive-bridge.md
- macos-validation.md
- native-directory-readers.md
- native-file-workflows.md
- permission-validation.md
- post-goal-backlog.md
- providers.md
- public-release.md
- README.md
- remote-settings.md
- repository-apps.md
- runtime-apps.md
- service-availability.md
- settings.md
- ssh-host-trust.md
- system-api.md
- system-clipboard.md
- terminal-services.md
- text-editor.md
- theme-goal.md
- themes.md
- transfers.md
- verification.md
- window-management.md
- windows-filesystem-behavior.md
- windows-host-validation.md
- windows-keyboard-deadlock.md
- workspace-bindings.md
- workspace-profiles.md
- - icon.svg
  - main.ts
  - shellcanvas.json
  - style.css
- - adapter.json
- - icon.svg
  - main.ts
  - shellcanvas.json
  - style.css
- - LICENSE
  - package.json
  - README.md
  - tsconfig.json
- build-adapter-probe.mjs
- build-extension-probe.mjs
- build-macos-legacy.sh
- build-sdk-probe.mjs
- check-adapter-schemas.mjs
- check-public-repo.mjs
- check-release-version.mjs
- file-clipboard-probe.cs
- pack-adapter.mjs
- pack-app.mjs
- probe-live-file-clipboard.ps1
- probe-live-image-clipboard.ps1
- publish-platform-update.mjs
- run-catalog-probe.mjs
- run-extension-probe.mjs
- updater-manifest.check.mjs
- updater-manifest.mjs
- verification.check.mjs
- verification.mjs
- verify-adapter-sdk.mjs
- verify-sdk.mjs
- verify.mjs
- - SKILL.md
- - SKILL.md
- - SKILL.md
- - Editor.css
  - Editor.tsx
  - Files.tsx
  - HostDetails.tsx
  - registry.ts
  - Terminal.tsx
- - AdapterDiagnosticsPanel.css
  - AdapterDiagnosticsPanel.tsx
  - AppBoundary.tsx
  - AppIcon.css
  - AppIcon.test.tsx
  - AppIcon.tsx
  - AppLauncher.css
  - AppLauncher.test.tsx
  - AppLauncher.tsx
  - AppUpdate.css
  - AppUpdate.tsx
  - AppWindow.tsx
  - AttachDriveDialog.tsx
  - ConfirmDialog.css
  - ConfirmDialog.tsx
  - ConnectAdapterDialog.css
  - ConnectAdapterDialog.tsx
  - ConnectDialog.tsx
  - ContextMenu.tsx
  - DeleteFilesDialog.tsx
  - DriveBridgeSettings.css
  - DriveBridgeSettings.tsx
  - DriveMappings.css
  - DriveMappings.tsx
  - FileActionDialog.css
  - FileActionDialog.tsx
  - FileVolumes.css
  - FileVolumes.tsx
  - HostKeyReviewPanel.css
  - HostKeyReviewPanel.tsx
  - HostProfilePicker.css
  - HostProfilePicker.tsx
  - MoveFileDialog.tsx
  - RemoteSettings.css
  - RemoteSettings.tsx
  - SaveAsDialog.tsx
  - SettingsDialog.css
  - SettingsDialog.tsx
  - ShellCanvasMark.tsx
  - SystemDialogHost.css
  - SystemDialogHost.tsx
  - TransferPanel.css
  - TransferPanel.tsx
  - useVirtualRows.ts
  - WindowResizeHandles.tsx
  - WorkspaceWindows.tsx
- - AdapterManager.tsx
  - app-events.test.ts
  - app-events.ts
  - app-listing.test.ts
  - app-listing.ts
  - app-storage.test.ts
  - app-storage.ts
  - appearance.test.ts
  - appearance.ts
  - AppManager.css
  - catalog-coordination.ts
  - catalog.test.ts
  - catalog.ts
  - client-platform-runtime.test.ts
  - client-platform.test.ts
  - client-platform.ts
  - client.ts
  - clipboard-api.test.ts
  - clipboard-api.ts
  - ConnectionDialog.css
  - ConnectionDialog.tsx
  - console-bridge.test.ts
  - console-bridge.ts
  - custom-bridge.test.ts
  - custom-bridge.ts
  - desktop-runtime.css
  - desktop-runtime.test.ts
  - desktop-runtime.tsx
  - directory-bridge.test.ts
  - directory-bridge.ts
  - environment-api.ts
  - environment.ts
  - ExtensionCenter.tsx
  - ExtensionFrame.tsx
  - ExtensionManager.css
  - ExtensionManager.tsx
  - ExtensionWindow.tsx
  - file-bridge.test.ts
  - file-bridge.ts
  - file-clipboard-api.test.ts
  - file-clipboard-api.ts
  - frame-document.test.ts
  - frame-document.ts
  - host-settings-bridge.test.ts
  - host-settings-bridge.ts
  - image-clipboard-api.test.ts
  - image-clipboard-api.ts
  - network-bridge.test.ts
  - network-bridge.ts
  - package.test.ts
  - package.ts
  - permissions.ts
  - repository.test.ts
  - repository.ts
  - rpc.test.ts
  - rpc.ts
  - storage-api.ts
  - system-bridge.test.ts
  - system-bridge.ts
  - transfer-bridge.test.ts
  - transfer-bridge.ts
  - transfer-cleanup.test.ts
  - window-api.test.ts
  - window-api.ts
- - appearance.css
  - Appearance.tsx
  - model.test.ts
  - model.ts
  - runtime.ts
  - store.ts
  - theme.css
  - wallpaper.ts
- adapter-diagnostics.ts
- adapters.test.ts
- adapters.ts
- app-services.test.ts
- app-services.ts
- app-update.test.ts
- app-update.ts
- App.tsx
- clipboard-image.test.ts
- clipboard-image.ts
- clipboard.ts
- custom-services.test.ts
- custom-services.ts
- desktop-entry.tsx
- desktop.test.ts
- desktop.ts
- dialog-compat.css
- dialog-compat.ts
- directory-reader.test.ts
- directory-reader.ts
- directory-scan.test.ts
- directory-scan.ts
- drive-attachment-state.test.ts
- drive-attachment-state.ts
- editor-state.test.ts
- editor-state.ts
- file-clipboard.test.ts
- file-clipboard.ts
- file-copy.test.ts
- file-delete.test.ts
- file-delete.ts
- file-events.test.ts
- file-events.ts
- file-locations.test.ts
- file-navigation.test.ts
- file-navigation.ts
- file-selection.test.ts
- file-selection.ts
- file-view.test.ts
- file-view.ts
- legacy-layout.css
- main.tsx
- platform-compat.test.ts
- platform-compat.ts
- preferences.test.ts
- preferences.ts
- preview.ts
- remote-clock.test.ts
- remote-clock.ts
- save-as.test.ts
- save-as.ts
- sdk.test.ts
- sdk.ts
- service-status.test.ts
- services.test.ts
- services.ts
- session-services.test.ts
- session-services.ts
- styles.css
- system-api.ts
- system-dialogs.test.ts
- system-dialogs.ts
- text-save.test.ts
- text-save.ts
- transfer-errors.ts
- transfer-queue.test.ts
- transfer-queue.ts
- use-remote-clock.ts
- vite-env.d.ts
- window-resize.test.ts
- window-resize.ts
- workspace-bindings.test.ts
- workspace-bindings.ts
- workspace-identity.test.ts
- workspace-identity.ts
- workspaces.test.ts
- workspaces.ts
- - adapter-desktop-probe.html
  - adapter-desktop-probe.tsx
  - adapter-diagnostics.html
  - adapter-diagnostics.tsx
  - app-boundary.html
  - app-boundary.tsx
  - app-services.html
  - app-services.tsx
  - catalog-coordination-probe.html
  - catalog-coordination-probe.ts
  - connect-dismiss-probe.html
  - connect-dismiss-probe.tsx
  - connection-ui-probe.html
  - connection-ui-probe.tsx
  - copy-paste.html
  - copy-paste.tsx
  - copy.html
  - copy.tsx
  - custom-service-client.ts
  - desktop-probe-client.ts
  - directory-desktop-probe.html
  - directory-desktop-probe.tsx
  - editor-clipboard.html
  - editor-clipboard.tsx
  - filesystem-provider.ts
  - filesystems.html
  - filesystems.tsx
  - host-trust.html
  - host-trust.tsx
  - hosts.html
  - hosts.tsx
  - limited-desktop.html
  - limited-desktop.tsx
  - live-image-clipboard-probe.html
  - live-image-clipboard-probe.ts
  - manager-review-probe.html
  - manager-review-probe.tsx
  - native-desktop-probe.html
  - native-desktop-probe.tsx
  - native-frame-probe-client.ts
  - native-frame-probe.html
  - native-frame-probe.ts
  - native-workspace.html
  - native-workspace.tsx
  - posix-relocation.ts
  - remote-clock-probe.html
  - remote-clock-probe.tsx
  - remote-settings.html
  - remote-settings.tsx
  - runtime-app.html
  - runtime-app.tsx
  - runtime-catalog.html
  - runtime-catalog.tsx
  - save-as.html
  - save-as.tsx
  - sdk-starter-client.ts
  - sdk-starter-probe.html
  - sdk-starter-probe.tsx
  - selection.html
  - selection.tsx
  - service-status.html
  - service-status.tsx
  - sort.html
  - sort.tsx
  - source-switch-probe.html
  - source-switch-probe.tsx
  - storage-probe.ts
  - system-api.html
  - system-api.tsx
  - terminal.html
  - terminal.tsx
  - transfers.html
  - transfers.tsx
  - volumes.html
  - volumes.tsx
  - workspaces.html
  - workspaces.tsx
- native_copy_fixture.py
.gitattributes
.gitignore
BACKLOG.md
Cargo.lock
Cargo.toml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
index.html
LICENSE
package-lock.json
package.json
README.md
ROADMAP.md
SECURITY.md
tsconfig.json
vite.config.ts

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Turn the servers you reach over SSH into a real desktop. 
 Files, terminals, an editor and apps, in windows you arrange, running on your computer. 
 Nothing to install on the server.

Files, Terminal and the editor on one connected server. Screenshots use sample hosts and data.

## Why ShellCanvas

SSH gives you a shell. ShellCanvas gives you the rest of a computer: a file manager that feels local, an editor that saves safely, terminals side by side and apps that know which host they are working on. It all runs on your machine and talks to your server over plain SSH, the connection you already use.

- **A desktop, not a dashboard.** Move, resize, tile and minimize real windows between a top bar and a dock. Open several Files and Terminal windows per host.
- **Nothing to install on the server.** ShellCanvas uses the SSH server your machine already runs, with SFTP for files. No agent, no daemon, only SSH.
- **Trust you can see.** A new host's key is shown for review before you sign in, and a changed key is refused. Passwords and passphrases are never saved.
- **Room to grow.** Install apps straight from GitHub, switch themes, or build your own apps and connection adapters with the public SDKs.

## Quick links

[Download](https://github.com/techartdev/ShellCanvas/releases/latest) · [Website](https://shellcanvas.com) · [Documentation](https://shellcanvas.com/docs/) · [Get started](#get-started) · [Build apps and adapters](#build-for-shellcanvas) · [AI development skills](docs/ai-development-skills.md) · [Contribute](CONTRIBUTING.md) · [Discord Server](https://discord.gg/3brUndnRnQ)

Related public repositories:

| Project | What it adds |
| --- | --- |
| [Canvas Assistant](https://github.com/techartdev/ShellCanvas-Assistant) | An optional AI assistant with conversations, attachments and remote workspace tools that require your approval. |
| [Drive Bridge](https://github.com/techartdev/ShellCanvas-DriveBridge) | An optional free app for attaching remote folders as local drives, with WinFsp and FUSE backends. Development preview. |

## A quick tour

### Files that feel local

Browse with places, a path bar and a filter. Select many items at once, and reach everyday actions from a context menu with the shortcuts you expect: rename with <kbd>F2</kbd>, cut and paste between Files windows with <kbd>Ctrl</kbd>+<kbd>X</kbd> and <kbd>Ctrl</kbd>+<kbd>V</kbd>, move or copy to another folder, delete. Upload and download files or whole folders through a queue that shows progress and can be cancelled. ShellCanvas never overwrites something that already exists.

On Windows, copy files and folders from ShellCanvas and paste them into File Explorer, or the other way round.

### Terminal and editor, side by side

Terminals are real shells over SSH. Open several at once, each with its own session, a right-click menu, and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> / <kbd>V</kbd> for the clipboard while <kbd>Ctrl</kbd>+<kbd>C</kbd> still interrupts.

The editor opens UTF-8 text files up to 256 KiB, with find, undo, word wrap and Save As. Before it saves, ShellCanvas checks that nobody changed the file on the server in the meantime, then replaces it atomically on servers that support it, such as OpenSSH.

### Every host gets its own space

Connect to several machines at once and switch between them from the top bar. Each workspace keeps its own windows, folders and terminal output. If a connection drops, reconnect in place: your windows, folders and unsaved drafts are still there, and terminals start fresh shells.

### Connect with confidence

Pick a saved host or import one from `~/.ssh/config`, then sign in with a key or a password. Host keys are checked against your OpenSSH `known_hosts` and ShellCanvas's own trust store before authentication. A new server shows its fingerprint for you to confirm, and a server whose key changed is blocked.

### Apps, whenever you want them

Open everything from the launcher, and add more with App Manager. Install from a public GitHub repository or a package file, review exactly what each app may access, and check for updates later. On Windows, installed apps run in an isolated frame and get only the access you approve.

Want an assistant on the desktop? [Canvas Assistant](https://github.com/techartdev/ShellCanvas-Assistant) is an optional app that talks to an OpenAI-compatible model you configure. It can look through files in your workspace, and every file change or terminal command it proposes waits for your approval.

### Make it yours

Canvas, the built-in theme, comes in light and dark and can follow your system. Choose a wallpaper or use your own photo, scale the interface from 80 to 150 percent and size the dock to taste. Themes are plain data files you can install from disk or GitHub, so anyone can make one; start from [Canvas Study](examples/themes/canvas-study).

## Get started

1. **Download** the latest [release](https://github.com/techartdev/ShellCanvas/releases/latest): the `.exe` setup installs for your user account, or use the `.msi` package. Preview builds are not code-signed yet, so Windows may warn about an unknown publisher. Each release lists SHA-256 checksums in `SHA256SUMS.txt`.
2. **Add a host.** Enter its address, your user name and a private key or password, or choose an entry from `~/.ssh/config`.
3. **Verify and connect.** Compare the fingerprint, confirm it, and your workspace opens with Files and a terminal.

**You need** Windows (x64) with the Microsoft Edge WebView2 runtime, which Windows 11 includes, and a server running SSH. Files, the editor and transfers also need SFTP, which OpenSSH provides.

## Where things stand

ShellCanvas is young and says so. Support claims come from tests on real systems, and this table lists only what has been checked.

| Area | Status |
| --- | --- |
| **Windows client** | Released as NSIS and MSI installers (x64, not yet code-signed). |
| **macOS client** | Builds from source. Launch, layout and Settings are confirmed on an Intel Mac running Catalina; SSH workflows on the Mac client are not validated yet. |
| **Linux client** | Not validated yet. |
| **Linux servers** | Files, terminal, editing and transfers are verified on an Ubuntu test server. Other distributions use the same SSH and SFTP path but have not been tested. |
| **macOS servers** | Browsing files and a live shell are confirmed; writes and transfers are not validated yet. |
| **Windows OpenSSH servers** | Not validated yet. |

Also on the way: signed installers, validated macOS and Linux clients, and [Drive Bridge](https://github.com/techartdev/ShellCanvas-DriveBridge), a separate free app in preview that attaches a remote folder as a local drive. The connection model is ready for more than SSH (for example serial, Telnet, FTP or a device API per workspace), but those adapters are not built yet. See the [roadmap](ROADMAP.md).

## Build for ShellCanvas

**Apps.** The [app SDK](docs/app-sdk.md) generates a project, type-checks it and builds a single installable package. No desktop rebuild or restart is needed.

```sh
npx --package @techartdev/shellcanvas-app-sdk shellcanvas-app init my-notes --id org.example.notes --title "My Notes"
cd my-notes
npm install
npm run build   # writes dist/app.shellcanvas.json
```

In App Manager, choose **Add apps → Choose package…** and pick the result. To share it, run `npx shellcanvas-app repository . --description "What it does"` and commit the generated `shellcanvas.repo.json` so others can install it from GitHub.

**Connection adapters.** The Rust [`shellcanvas-adapter-sdk`](https://docs.rs/shellcanvas-adapter-sdk) and its `shellcanvas-adapter` CLI create, build and validate native adapters that add file, console, settings or custom services to a workspace. See the [adapter SDK guide](docs/adapter-sdk.md) and the [filesystem SDK](crates/filesystem-sdk).

Both SDKs are at 0.1 and still provisional. The repository's [AI development skills](docs/ai-development-skills.md) help coding agents build apps and adapters against them.

## Build from source

You need Node.js 22+, Rust 1.93+ and the [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/) for your platform.

```sh
npm ci
npm run desktop           # run the desktop app with live reload
npm run dev               # browser design preview with sample data, no SSH
npm run verify            # formatting, tests and lint; add -- --native to also build the app
npm run release:windows   # NSIS and MSI installers
```

The [engineering documentation](docs/README.md) covers the architecture, contracts and verification records.

## Contributing

Bug reports, compatibility reports from new systems and focused pull requests are all welcome. Start with the [contributing guide](CONTRIBUTING.md). Report security issues privately as described in the [security policy](SECURITY.md), and follow the [code of conduct](CODE_OF_CONDUCT.md). Changes are tracked in the [changelog](CHANGELOG.md).

## License

ShellCanvas is licensed under the [Mozilla Public License 2.0](LICENSE). Modified MPL-covered files stay under the MPL when distributed; separate apps, themes and adapters may use their own licenses.

Made with Tauri, Rust and React · <a href="https://shellcanvas.com">shellcanvas.com</a>

ShellCanvas

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

ShellCanvas

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README