# NovalTerm

**Repository Path**: lightnehum/noval-term

## Basic Information

- **Project Name**: NovalTerm
- **Description**: 基于.Net的现代化SSH工具
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://noval.net.cn/novalterm/
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-10-15
- **Last Updated**: 2026-11-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NovalTerm

A cross-platform SSH workbench built with **.NET 10 and Avalonia UI**, targeting Windows, Linux and macOS.

`NovalTerm.slnx` builds the native desktop application and portable tests. The original WPF application remains in `NovalTerm.Legacy.Windows.slnx` as a reference. See [migration and validation status](docs/avalonia-migration.md).

Project home and issue tracker: [NovalTerm on Gitee](https://gitee.com/lightnehum/noval-term).

```powershell
git clone https://gitee.com/lightnehum/noval-term.git
cd noval-term
```

## User guide (Chinese)

Read the [detailed user guide](docs/user-guide.md) for connection setup, terminals, SFTP, editing, monitoring, Docker/Kubernetes, tunnels and troubleshooting. In the app, choose **菜单 → 使用帮助** or press **F1** in the main window to open the same guide offline, with chapter navigation and keyword search.

Download the Windows x64 installer from the [releases page](https://gitee.com/lightnehum/noval-term/releases). It includes the .NET runtime and lets you choose the installation directory and a desktop shortcut. For a portable ZIP, extract all files before running `NovalTerm.Desktop.exe`.

SFTP supports downloading multiple files and folders recursively, with confirmation before replacing existing files. The transfer center shows queued tasks, progress and cancellation; resume downloads from the remote file context menu. See the guide for limitations and recovery steps.

## Status

The default client now uses Avalonia UI, including connection management, SSH/SFTP/tunnel adapters and an in-house terminal component. Full V1.0 acceptance and performance validation remain in progress.

## Design documents (Chinese)

1. [Requirements and scope](docs/design/01-requirements.md)
2. [UI and interaction design](docs/design/02-ux-design.md)
3. [Technical architecture](docs/design/03-architecture.md)
4. [Data and security](docs/design/04-data-security.md)
5. [Delivery and acceptance plan](docs/design/05-delivery-plan.md)

The baseline targets Windows, Linux and macOS and local-first use by individuals and small operations teams. The application now uses an in-house C# VT core and native Avalonia terminal renderer, with SSH.NET for SSH/SFTP. There is no HTML, JavaScript, WebView2 or external terminal component.

Build and run with .NET 10 SDK on Windows, Linux or macOS:

```powershell
dotnet restore NovalTerm.slnx --configfile NuGet.Config
dotnet run --project src/NovalTerm.Desktop -c Release
dotnet test NovalTerm.slnx -c Release
```

This is a development build. The complete V1.0 feature, real-server compatibility and performance acceptance matrices are not yet complete. See [development guide](docs/development.md) and [native terminal ADR](docs/adr/0001-native-wpf-terminal.md).

## License

[Apache License 2.0](LICENSE). Third-party dependencies and redistribution terms require separate review.