chore: release v1.1.0

Queued transfers stored only the destination directory as the target
path. Downstream upload logic treats the queued destination as the full
file path and passes it straight to create_file, so transfers failed
with a Failure error when the remote target resolved to a directory.

Append each entry's file name to the destination directory at enqueue
time in both enqueue_file and enqueue_all, matching the single-file
transfer path which already builds the full target path.

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: veeso
+liberapay: veeso

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,9 +1,9 @@
 ---
 name: Bug report
-about: Create a report to help me improving TermSCP
-title: "[BUG]"
+about: Create a report of the bug you've encountered
+title: "[BUG] - ISSUE_TITLE"
 labels: bug
-assignees: ChristianVisintin
+assignees: veeso
 
 ---
 
@@ -24,10 +24,15 @@ A clear and concise description of what you expected to happen.
 - OS: [e.g. GNU/Linux Debian 10]
 - Architecture [Arm, x86_64, ...]
 - Rust version
-- TermSCP version
+- termscp version
 - Protocol used
 - Remote server version and name
 
+## Log
+
+Report the snippet of the log file containing the unexpected behaviour.
+If there is any information you consider to be confidential, shadow it.
+
 ## Additional information
 
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/copy.md

@@ -0,0 +1,35 @@
+---
+name: Copy
+about: Report a typo/error in a repository document
+title: "[COPY] - ISSUE_TITLE"
+labels: documentation
+assignees: veeso
+
+---
+
+## Report
+
+### DOCUMENT NAME
+
+This sentence at row ROW_NUMBER doesn't seem right:
+
+> Write down here the wrong sentence
+
+and I think it should be changed to:
+
+> Write down here the correct sentence
+
+`Copy paste the template above for all the sentences to fix`
+
+---
+
+`Copy paste the template above for all the documents to fix`
+
+## Additional information
+
+> ❗ Report LANGUAGE checks only if it concerns the documents above
+> ❗ If the documents concerns more than one language, copy paste the checks below for each check you want to report
+> ❗ The PR mention regards the indicated language. If you check the box, I may add you to a PR where I need to translate a new section of the user manual/README or other documents. I promise I won't stress you anyway.
+
+- [ ] I am C1/C2 speaker for this language: LANGUAGE
+  - [ ] You can mention me in a PR in case a review for translations is needed

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,12 +1,23 @@
 ---
 name: Feature request
-about: Suggest an idea for TermSCP
-title: "[Feature Request]"
-labels: enhancement
-assignees: ChristianVisintin
+about: Suggest an idea to improve termscp
+title: "[Feature Request] - FEATURE_TITLE"
+labels: "new feature"
+assignees: veeso
 
 ---
 
 ## Description
 
-Describe the feature you'd like to be added
+Put here a brief introduction to your suggestion.
+
+### Changes
+
+The following changes to the application are expected
+
+- ...
+
+## Implementation
+
+Provide any kind of suggestion you propose on how to implement the feature.
+If you have none, delete this section.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,8 @@
+---
+name: Question
+about: Ask what you want about the project
+title: "[QUESTION] - TITLE"
+labels: question
+assignees: veeso
+
+---

.github/ISSUE_TEMPLATE/security.md

@@ -0,0 +1,23 @@
+---
+name: Security report
+about: Create a report of a security vulnerability
+title: "[SECURITY] - ISSUE_TITLE"
+labels: security
+assignees: veeso
+
+---
+
+## Description
+
+Severity:
+
+- [ ] **critical**
+- [ ] high
+- [ ] medium
+- [ ] low
+
+A clear and concise description of the security vulnerability.
+
+## Additional information
+
+Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-# Pull Request Title
+# ISSUE _NUMBER_ - PULL_REQUEST_TITLE
 
 Fixes # (issue)
 
@@ -25,7 +25,16 @@ Please select relevant options.
 - [ ] My code follows the contribution guidelines of this project
 - [ ] I have performed a self-review of my own code
 - [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
 - [ ] My changes generate no new warnings
+- [ ] I formatted the code with `cargo fmt`
+- [ ] I checked my code using `cargo clippy` and reports no warnings
 - [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I have introduced no new *C-bindings*
+- [ ] The changes I've made are Windows, MacOS, UNIX, Linux compatible (or I've handled them using `cfg target_os`)
+- [ ] I increased or maintained the code coverage for the project, compared to the previous commit
+
+## Acceptance tests
+
+wait for a *project maintainer* to fulfill this section...
+
+- [ ] regression test: ...

.github/actions-rs/grcov.yml

@@ -0,0 +1,16 @@
+branch: false
+ignore-not-existing: true
+llvm: true
+output-type: lcov
+ignore:
+  - "/*"
+  - "C:/*"
+  - "../*"
+  - src/main.rs
+  - src/activity_manager.rs
+  - src/cli_opts.rs
+  - src/support.rs
+  - src/system/notifications.rs
+  - "src/ui/activities/*"
+  - src/ui/context.rs
+  - src/ui/input.rs

.github/workflows/ci.yml

@@ -0,0 +1,68 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - "*.md"
+      - "./site/**/*"
+  push:
+    branches: [main]
+    paths-ignore:
+      - "*.md"
+      - "./site/**/*"
+
+env:
+  CARGO_TERM_COLOR: always
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: build-(${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          persist-credentials: false
+      - name: Install Linux dependencies
+        if: runner.os == 'Linux'
+        run: sudo apt update && sudo apt install -y libdbus-1-dev libsmbclient-dev
+      - name: Install macOS dependencies
+        if: runner.os == 'macOS'
+        run: |
+          brew update
+          brew install \
+          pkg-config \
+          samba
+          brew link --force samba
+      - name: Install nightly toolchain
+        if: runner.os == 'Linux'
+        uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8 # stable
+        with:
+          toolchain: nightly
+          components: rustfmt
+      - name: Format
+        if: runner.os == 'Linux'
+        run: cargo +nightly fmt --all -- --check
+      - name: Install stable toolchain
+        uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8 # stable
+        with:
+          toolchain: stable
+          components: clippy
+      - name: Build
+        if: runner.os != 'Linux'
+        run: cargo build
+      - name: Run tests (Linux)
+        if: runner.os == 'Linux'
+        run: cargo test --no-default-features --features github-actions --no-fail-fast
+      - name: Run tests
+        if: runner.os != 'Linux'
+        run: cargo test --verbose --features github-actions
+      - name: Clippy
+        run: cargo clippy -- -Dwarnings

.github/workflows/codeberg-mirror.yml

@@ -0,0 +1,21 @@
+name: codeberg-mirror
+on:
+  push:
+
+permissions:
+  contents: read
+
+jobs:
+  mirror:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: "Mirror to Codeberg"
+        uses: yesolutions/mirror-action@1708f16cdb28634fd3ba10c5c79abc91f5578a14 # v0.7.0
+        with:
+          REMOTE: 'ssh://git@codeberg.org/veeso/termscp.git'
+          GIT_SSH_PRIVATE_KEY: ${{ secrets.GIT_SSH_PRIVATE_KEY }}
+          GIT_SSH_NO_VERIFY_HOST: "true"

.github/workflows/install.yml

@@ -0,0 +1,32 @@
+name: Install.sh
+
+on:
+  push:
+    branches: [main]
+    tags:
+      - "v*"
+
+env:
+  CARGO_TERM_COLOR: always
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          persist-credentials: false
+      - name: Install termscp from script
+        run: |
+          ./install.sh -f
+          which termscp || exit 1
+          termscp --version

.github/workflows/linux.yml

@@ -1,22 +0,0 @@
-name: Linux
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-env:
-  CARGO_TERM_COLOR: always
-
-jobs:
-  build:
-    
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose

.github/workflows/macos.yml

@@ -1,22 +0,0 @@
-name: MacOS
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-env:
-  CARGO_TERM_COLOR: always
-
-jobs:
-  build:
-    
-    runs-on: macos-10.14
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose

.github/workflows/pages.yml

@@ -0,0 +1,66 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - ".github/workflows/pages.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          persist-credentials: false
+      - name: Install mdBook
+        uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08 # v2
+        with:
+          mdbook-version: latest
+      - name: Install mdbook-mermaid
+        run: cargo install mdbook-mermaid
+      - name: Build en-US
+        run: mdbook build docs/en-US
+      - name: Build zh-CN
+        run: mdbook build docs/zh-CN
+      - name: Assemble site
+        run: |
+          rm -rf site_out
+          mkdir -p site_out/en-US site_out/zh-CN
+          cp -r docs/en-US/book/* site_out/en-US/
+          cp -r docs/zh-CN/book/* site_out/zh-CN/
+          cp -r docs/shared site_out/shared
+          cp docs/shared/og_preview.jpg site_out/og_preview.jpg
+          cp docs/shared/favicon.ico site_out/favicon.ico
+          cp docs/CNAME site_out/CNAME
+          cat > site_out/index.html <<'HTML'
+          <!doctype html>
+          <meta charset="utf-8">
+          <title>termscp docs</title>
+          <meta http-equiv="refresh" content="0; url=./en-US/">
+          <link rel="canonical" href="./en-US/">
+          <a href="./en-US/">termscp documentation</a>
+          HTML
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
+        with:
+          path: site_out
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

.github/workflows/release.yml

@@ -0,0 +1,448 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release, e.g. 1.1.0 (no leading v)"
+        required: true
+        type: string
+      dry_run:
+        description: "Dry run: build & compute everything, push/publish nothing"
+        required: true
+        type: boolean
+        default: true
+
+permissions:
+  contents: read
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ inputs.version }}
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          token: ${{ secrets.RELEASE_PAT }}
+          persist-credentials: true
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Configure git identity
+        run: |
+          git config user.name "veeso"
+          git config user.email "christian.visintin@veeso.dev"
+
+      - name: Install git-cliff
+        uses: taiki-e/install-action@56545b37b57562edd73171cb6c62cc509db4c34e # v2
+        with:
+          tool: git-cliff
+
+      - name: Bump version
+        env:
+          VERSION: ${{ inputs.version }}
+        run: dist/release/bump_version.sh "$VERSION" "$(date +%F)"
+
+      - name: Generate CHANGELOG
+        env:
+          VERSION: ${{ inputs.version }}
+        run: git-cliff --tag "v$VERSION" -o CHANGELOG.md
+
+      - name: Generate release notes
+        env:
+          VERSION: ${{ inputs.version }}
+        run: git-cliff --unreleased --tag "v$VERSION" --strip header -o RELEASE_NOTES.md
+
+      - name: Upload release notes
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: release-notes
+          path: RELEASE_NOTES.md
+          retention-days: 1
+          if-no-files-found: error
+
+      - name: Show diff (dry run)
+        if: ${{ inputs.dry_run }}
+        run: git --no-pager diff
+
+      - name: Commit & push version bump
+        if: ${{ !inputs.dry_run }}
+        env:
+          VERSION: ${{ inputs.version }}
+        run: |
+          rm -f RELEASE_NOTES.md
+          git add -A
+          git commit -m "chore: release v$VERSION"
+          git push origin HEAD:main
+
+  build:
+    needs: prepare
+    name: build-${{ matrix.target }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - target: x86_64-unknown-linux-gnu
+            os: ubuntu-latest
+            kind: linux
+            deb_suffix: amd64
+          - target: aarch64-unknown-linux-gnu
+            os: ubuntu-24.04-arm
+            kind: linux
+            deb_suffix: arm64
+          - target: aarch64-apple-darwin
+            os: macos-latest
+            kind: macos
+            features: "--features smb-vendored"
+          - target: x86_64-apple-darwin
+            os: macos-latest
+            kind: macos
+            features: "--no-default-features --features keyring"
+          - target: x86_64-pc-windows-msvc
+            os: windows-latest
+            kind: windows
+          - target: aarch64-pc-windows-msvc
+            os: windows-11-arm
+            kind: windows
+    runs-on: ${{ matrix.os }}
+    env:
+      VERSION: ${{ needs.prepare.outputs.version }}
+      TARGET: ${{ matrix.target }}
+      FEATURES: ${{ matrix.features }}
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          ref: ${{ inputs.dry_run && github.sha || 'main' }}
+          persist-credentials: false
+          fetch-depth: 0
+          fetch-tags: true
+      - uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8 # stable
+        with:
+          targets: ${{ matrix.target }}
+
+      # ---- Linux: native per-arch build (x86_64 on ubuntu-latest, aarch64 on ubuntu-24.04-arm) ----
+      - name: Install dependencies (Linux)
+        if: matrix.kind == 'linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            make \
+            libgit2-dev \
+            build-essential \
+            pkg-config \
+            libbsd-dev \
+            libcap-dev \
+            libcups2-dev \
+            libgnutls28-dev \
+            libicu-dev \
+            libjansson-dev \
+            libkeyutils-dev \
+            libldap2-dev \
+            zlib1g-dev \
+            libpam0g-dev \
+            libacl1-dev \
+            libarchive-dev \
+            flex \
+            bison \
+            libntirpc-dev \
+            libtracker-sparql-3.0-dev \
+            libglib2.0-dev \
+            libdbus-1-dev \
+            libsasl2-dev \
+            libunistring-dev \
+            cpanminus
+          sudo cpanm Parse::Yapp::Driver
+          cargo install cargo-deb
+      - name: Build (Linux)
+        if: matrix.kind == 'linux'
+        run: cargo build --release --features smb-vendored --target "$TARGET"
+      - name: Build deb (Linux)
+        if: matrix.kind == 'linux'
+        run: cargo deb --no-build --target "$TARGET" --features smb-vendored
+
+      # ---- macOS ----
+      - name: Install deps (macOS)
+        if: matrix.kind == 'macos'
+        run: |
+          brew update
+          brew install bison cpanminus cups flex gettext gmp gnutls icu4c jansson \
+            libarchive libbsd libunistring libgit2 libtirpc openldap pkg-config zlib
+          for p in bison cups flex gettext gmp gnutls icu4c jansson libarchive \
+            libbsd libgit2 libtirpc libunistring openldap zlib; do brew link --force "$p"; done
+          cpanm Parse::Yapp::Driver
+      - name: Build (macOS)
+        if: matrix.kind == 'macos'
+        run: cargo build --release $FEATURES --target "$TARGET"
+
+      # ---- Windows ----
+      - name: Build (Windows)
+        if: matrix.kind == 'windows'
+        run: cargo build --release --features smb-vendored --target "$env:TARGET"
+
+      # ---- Package posix (tar.gz) ----
+      - name: Package (posix)
+        if: matrix.kind != 'windows'
+        run: |
+          mkdir -p artifact
+          cp "target/$TARGET/release/termscp" artifact/termscp
+          tar -czf "artifact/termscp-v$VERSION-$TARGET.tar.gz" -C artifact termscp
+          shasum -a 256 "artifact/termscp-v$VERSION-$TARGET.tar.gz" | awk '{print $1}' > "artifact/$TARGET.sha256"
+
+      # ---- Package windows (zip) ----
+      - name: Package (windows)
+        if: matrix.kind == 'windows'
+        shell: pwsh
+        run: |
+          New-Item -ItemType Directory -Force artifact | Out-Null
+          Copy-Item "target/$env:TARGET/release/termscp.exe" artifact/termscp.exe
+          Compress-Archive -Path artifact/termscp.exe -DestinationPath "artifact/termscp-v$env:VERSION-$env:TARGET.zip"
+          (Get-FileHash "artifact/termscp-v$env:VERSION-$env:TARGET.zip" -Algorithm SHA256).Hash.ToLower() | Out-File -NoNewline "artifact/$env:TARGET.sha256"
+
+      - name: Move deb into artifact dir (Linux)
+        if: matrix.kind == 'linux'
+        run: cp target/"$TARGET"/debian/*.deb artifact/
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: build-${{ matrix.target }}
+          path: artifact/*
+          retention-days: 1
+          if-no-files-found: error
+
+  publish-homebrew:
+    needs: [prepare, build]
+    runs-on: ubuntu-latest
+    env:
+      VERSION: ${{ needs.prepare.outputs.version }}
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
+        with:
+          pattern: build-*
+          path: dl
+          merge-multiple: true
+
+      - name: Checkout homebrew tap
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          repository: veeso/homebrew-termscp
+          token: ${{ secrets.RELEASE_PAT }}
+          path: tap
+          persist-credentials: true
+
+      - name: Rewrite formula
+        run: |
+          set -euo pipefail
+          cd "$GITHUB_WORKSPACE"
+          SHA_MAC_ARM=$(cat dl/aarch64-apple-darwin.sha256)
+          SHA_MAC_X64=$(cat dl/x86_64-apple-darwin.sha256)
+          SHA_LIN_ARM=$(cat dl/aarch64-unknown-linux-gnu.sha256)
+          SHA_LIN_X64=$(cat dl/x86_64-unknown-linux-gnu.sha256)
+          BASE="https://github.com/veeso/termscp/releases/latest/download"
+          cat > tap/Formula/termscp.rb <<EOF
+          class Termscp < Formula
+            desc "A feature rich terminal file transfer and explorer with support for SCP/SFTP/FTP/S3/Kube/SMB/WebDAV"
+            homepage "https://termscp.rs/"
+            license "MIT"
+            version "$VERSION"
+
+            on_macos do
+              depends_on "bison"
+              depends_on "cups"
+              depends_on "flex"
+              depends_on "gettext"
+              depends_on "gmp"
+              depends_on "gnutls"
+              depends_on "icu4c"
+              depends_on "jansson"
+              depends_on "libarchive"
+              depends_on "libbsd"
+              depends_on "libgit2"
+              depends_on "libtirpc"
+              depends_on "libunistring"
+              depends_on "openldap"
+              depends_on "zlib"
+
+              on_arm do
+                url "$BASE/termscp-v$VERSION-aarch64-apple-darwin.tar.gz"
+                sha256 "$SHA_MAC_ARM"
+              end
+              on_intel do
+                url "$BASE/termscp-v$VERSION-x86_64-apple-darwin.tar.gz"
+                sha256 "$SHA_MAC_X64"
+              end
+            end
+
+            on_linux do
+              depends_on "dbus"
+
+              on_arm do
+                url "$BASE/termscp-v$VERSION-aarch64-unknown-linux-gnu.tar.gz"
+                sha256 "$SHA_LIN_ARM"
+              end
+              on_intel do
+                url "$BASE/termscp-v$VERSION-x86_64-unknown-linux-gnu.tar.gz"
+                sha256 "$SHA_LIN_X64"
+              end
+            end
+
+            def install
+              bin.install "termscp"
+            end
+          end
+          EOF
+
+      - name: Show formula (dry run)
+        if: ${{ inputs.dry_run }}
+        run: cat tap/Formula/termscp.rb
+
+      - name: Commit & push formula
+        if: ${{ !inputs.dry_run }}
+        run: |
+          cd tap
+          git config user.name "veeso"
+          git config user.email "christian.visintin@veeso.dev"
+          git add Formula/termscp.rb
+          git commit -m "termscp $VERSION"
+          git push
+
+  release:
+    needs: [prepare, build]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    env:
+      VERSION: ${{ needs.prepare.outputs.version }}
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          token: ${{ secrets.RELEASE_PAT }}
+          ref: ${{ inputs.dry_run && github.sha || 'main' }}
+          persist-credentials: true
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
+        with:
+          pattern: build-*
+          path: dl
+          merge-multiple: true
+
+      - name: Download release notes
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
+        with:
+          name: release-notes
+          path: notes
+
+      - name: Patch chocolatey checksums & pack
+        run: |
+          set -euo pipefail
+          SHA_WIN_X64=$(cat dl/x86_64-pc-windows-msvc.sha256)
+          SHA_WIN_ARM=$(cat dl/aarch64-pc-windows-msvc.sha256)
+          PS=dist/chocolatey/tools/chocolateyinstall.ps1
+          # arm checksum is the first $checksum line, x64 the second (matches file order)
+          SHA_WIN_ARM="$SHA_WIN_ARM" SHA_WIN_X64="$SHA_WIN_X64" \
+            perl -0pi -e 'BEGIN{our $n=0} s/(\$checksum\s*=\s*'"'"')[0-9a-f]*('"'"')/ $n++==0 ? "${1}$ENV{SHA_WIN_ARM}${2}" : "${1}$ENV{SHA_WIN_X64}${2}" /ge' "$PS"
+          docker run --rm -v "$PWD/dist/chocolatey:/work" -w /work \
+            chocolatey/choco:latest choco pack --output-directory /work
+
+      - name: Assemble release assets
+        run: |
+          mkdir -p out
+          cp dl/*.tar.gz dl/*.deb dl/*.zip out/ 2>/dev/null || true
+          cp dist/chocolatey/*.nupkg out/
+
+      - name: Upload assets artifact (dry run)
+        if: ${{ inputs.dry_run }}
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: release-assets-dryrun
+          path: out/*
+          retention-days: 3
+
+      - name: Create GitHub release
+        if: ${{ !inputs.dry_run }}
+        env:
+          GH_TOKEN: ${{ secrets.RELEASE_PAT }}
+        run: |
+          gh release create "v$VERSION" out/* \
+            --title "v$VERSION" \
+            --notes-file notes/RELEASE_NOTES.md
+
+  publish-crate:
+    needs: [prepare, release]
+    if: ${{ !inputs.dry_run }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    env:
+      VERSION: ${{ needs.prepare.outputs.version }}
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          ref: main
+          persist-credentials: false
+          fetch-depth: 0
+          fetch-tags: true
+      - uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8 # stable
+
+      - name: Install dependencies (Linux)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            make \
+            libgit2-dev \
+            build-essential \
+            pkg-config \
+            libbsd-dev \
+            libcap-dev \
+            libcups2-dev \
+            libgnutls28-dev \
+            libicu-dev \
+            libjansson-dev \
+            libkeyutils-dev \
+            libldap2-dev \
+            zlib1g-dev \
+            libpam0g-dev \
+            libacl1-dev \
+            libarchive-dev \
+            flex \
+            bison \
+            libntirpc-dev \
+            libtracker-sparql-3.0-dev \
+            libglib2.0-dev \
+            libdbus-1-dev \
+            libsasl2-dev \
+            libunistring-dev \
+            cpanminus
+          sudo cpanm Parse::Yapp::Driver
+
+      - name: Authenticate to crates.io
+        id: auth
+        uses: rust-lang/crates-io-auth-action@bbd81622f20ce9e2dd9622e3218b975523e45bbe # v1.0.4
+
+      - name: Publish to crates.io
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
+        run: cargo publish --features smb-vendored
+
+  publish-choco:
+    needs: [prepare, release]
+    if: ${{ !inputs.dry_run }}
+    runs-on: windows-latest
+    env:
+      VERSION: ${{ needs.prepare.outputs.version }}
+    steps:
+      - name: Download nupkg from release
+        env:
+          GH_TOKEN: ${{ secrets.RELEASE_PAT }}
+        run: gh release download "v$env:VERSION" --repo veeso/termscp --pattern "*.nupkg"
+
+      - name: Push to Chocolatey
+        env:
+          CHOCO_API_KEY: ${{ secrets.CHOCO_API_KEY }}
+        run: |
+          choco apikey --key $env:CHOCO_API_KEY --source https://push.chocolatey.org/
+          choco push (Get-ChildItem *.nupkg).Name --source https://push.chocolatey.org/

.github/workflows/site.yml

@@ -0,0 +1,38 @@
+name: Site
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+defaults:
+  run:
+    working-directory: site
+
+jobs:
+  build-site:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        with:
+          node-version: 24
+          cache: npm
+          cache-dependency-path: site/package-lock.json
+      - name: Install dependencies
+        run: npm ci
+      - name: Format
+        run: npm run format:check
+      - name: Lint
+        run: npm run check
+      - name: Test
+        run: npm test --if-present
+      - name: Build
+        run: npm run build

.github/workflows/stale.yml

@@ -0,0 +1,27 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+permissions:
+  contents: read
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@a20b814fb01b71def3bd6f56e7494d667ddf28da # v4.1.1
+        with:
+          days-before-issue-stale: 30
+          days-before-issue-close: 7
+          stale-issue-label: "stale"
+          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
+          close-issue-message: "This issue was closed because it has been inactive for 7 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          exempt-issue-labels: "backlog"
+          exempt-all-milestones: true

.github/workflows/windows.yml

@@ -1,22 +0,0 @@
-name: Windows
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-env:
-  CARGO_TERM_COLOR: always
-
-jobs:
-  build:
-    
-    runs-on: windows-2019
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose

.gitignore

@@ -13,3 +13,22 @@
 **/*.rs.bk
 
 # End of https://www.gitignore.io/api/rust
+
+# Distributions
+*.rpm
+*.deb
+dist/pkgs/arch/*.tar.gz
+
+# Macos
+.DS_Store
+
+dist/pkgs/
+dist/build/macos/openssl/
+
+.idea/
+.claude/
+
+
+# brainstorming visual companion
+.superpowers/
+docs/*/book/

.markdownlint-cli2.jsonc

@@ -0,0 +1,21 @@
+{
+  // Markdown lint config for the termscp docs site (mdBook).
+  "config": {
+    // Line length is impractical for keyboard/style tables and long prose;
+    // mdBook reflows in the browser, so we don't enforce a hard wrap.
+    "MD013": false,
+    // Table column alignment can't be satisfied for CJK (zh-CN) content:
+    // markdownlint counts code points while CJK glyphs are double-width, so a
+    // visually aligned table never matches. Rendering is unaffected.
+    "MD060": false
+  },
+  "globs": ["docs/en-US/**/*.md", "docs/zh-CN/**/*.md"],
+  "ignores": [
+    // mdBook build output.
+    "**/book/**",
+    // SUMMARY.md uses multiple level-1 headings as mdBook part titles.
+    "**/SUMMARY.md",
+    // GitHub READMEs (not part of the book) keep centered HTML badges.
+    "**/README.md"
+  ]
+}

CHANGELOG.md

@@ -1,12 +1,863 @@
-# Changelog
+## 1.1.0
 
-- [Changelog](#changelog)
-  - [0.1.0](#010)
+Released on 2026-06-08
 
----
+### Added
 
+- **site:** catppuccin theme tokens, tailwind 4, self-hosted font
+- **site:** i18n string resolver with en fallback
+- **site:** build-time man.md fetcher pinned to release ref
+- **site:** base layout with og/hreflang, theme bootstrap, umami
+- **site:** x-default hreflang, twitter card, og:image:alt; dedupe locales/site in base layout
+- **site:** nav, footer, theme toggle, language picker
+- **site:** responsive mobile nav, css-driven theme icons, localizePath helper
+- **site:** landing page with dual-pane explorer hero
+- **site:** install page led by install.sh script, package-manager tabs
+- **site:** robots, sitemap reference, vercel redirects + cache headers
+- **install:** add Windows PowerShell installer and copy buttons on site
+  > Add install.ps1 mirroring install.sh for Windows: arch detection,
+  > release zip download, binary extraction, user PATH update.
+  > 
+  > - copy install.ps1 to site public/ at build time (copy-install.mjs)
+  > - serve /install.ps1 with text/plain Content-Type (vercel.json)
+  > - add PowerShell one-liner to install page and README
+  > - bump install.ps1 default version in bump_version.sh
+  > - add CopyButton component next to every install command line
+- **config:** move config dir to ~/.config/termscp on macOS and %USERPROFILE%\.termscp on Windows
+  > Resolve the config directory through a single per-platform config_dir()
+  > function instead of relying on dirs::config_dir everywhere:
+  > 
+  > - macOS: ~/.config/termscp (was ~/Library/Application Support/termscp)
+  > - Windows: %USERPROFILE%\.termscp (was roaming %APPDATA%\termscp)
+  > - Linux/other: /termscp (unchanged)
+  > 
+  > Existing users are migrated automatically on first run: when the new
+  > directory is absent and the legacy location exists, the whole config
+  > directory is moved to the new path. The cache directory stays at the
+  > platform-native location.
+
+### CI
+
+- automated release workflow
+  > Single workflow_dispatch (version, dry_run) that bumps versions, regenerates
+  > CHANGELOG via git-cliff, rebuilds site CSS, builds all targets, creates the
+  > GitHub release, updates the Homebrew tap and publishes Chocolatey.
+  > 
+  > - dist/release/bump_version.sh: version replacer across all tracked locations (+tests)
+  > - .github/workflows/release.yml: prepare -> build matrix -> homebrew/release -> choco
+  > - retire build-artifacts.yml (merged into release.yml)
+  > - Linux builds via cargo-zigbuild (old glibc) for broad compatibility
+- pin all actions to verified SHAs and clear zizmor findings
+  > Pin every action to a commit SHA whose tag comment matches (verified via gh api),
+  > add least-privilege permissions, set persist-credentials: false, and replace the
+  > archived actions-rs/cargo with a plain cargo test. zizmor clean at default persona.
+- fix release notes generation in release workflow
+  > prepare job failed: git-cliff --latest crashed with 'trim_start_matches on
+  > null' because the checkout was shallow (no tags/history) so no release existed.
+  > 
+  > - checkout prepare with fetch-depth: 0 + fetch-tags so git-cliff sees full
+  >   history and tags (also fixes an otherwise-truncated CHANGELOG)
+  > - generate release notes with --unreleased --tag v$VERSION instead of --latest:
+  >   --latest selected the previous real tag (stale notes); --unreleased --tag
+  >   renders the version being released
+- remove pages workflow, fix release version-bump for astro site
+- **site:** add format/lint/test/build workflow for astro site
+  > Add Site GitHub Actions workflow running prettier format check, astro
+  > check, tests, and build on changes under site/. Wire prettier into the
+  > site package with config, ignore, and scripts, and format existing
+  > sources.
+- add github pages workflow for docs site
+- unify os workflows into one
+- **release:** publish to crates.io via OIDC trusted publishing
+- rename ci workflow
+- **site:** always run site
+- **release:** fetch full git history and tags for build.rs
+  > build.rs uses vergen-git2 (Git2::all_git), which runs `git describe` and
+  > reads commit metadata. The build and publish-crate jobs checked out a
+  > shallow clone without tags, so vergen could not resolve the describe
+  > string and libgit2 may fail on shallow repos. Add fetch-depth: 0 and
+  > fetch-tags: true to both jobs that compile the crate.
+
+### Changed
+
+- **site:** type-safe i18n keys derived from en
+- **site:** drop in-site manual, link to external docs.termscp.rs
+- **site:** english-only, remove i18n machinery
+
+### Documentation
+
+- point READMEs to termscp.rs + install.sh, docs.termscp.rs
+- replace last termscp.veeso.dev refs (install.sh manual/changelog, crate homepage)
+- add shared mdbook assets and favicon.ico
+- add mdbook language switcher script
+- add CNAME for docs.termscp.rs
+- scaffold en-US mdbook
+- add en-US table of contents
+- **en:** write introduction and getting-started pages
+- **en:** write usage pages
+- **en:** write configuration pages
+- **en:** write cli reference and developer pages
+- **en:** fix CLI references (no -t / --update flags; -b is a value option)
+- add markdownlint config for docs site
+- scaffold zh-CN mdbook
+- **zh:** translate introduction and getting-started pages
+- **zh:** translate section headings in getting-started pages
+- **zh:** translate usage pages
+- **zh:** translate configuration pages
+- **zh:** translate cli reference and developer pages
+- disable MD060 table alignment (incompatible with CJK width)
+- drop extra language docs/READMEs, point manual links to docs.termscp.rs
+- **zh:** align README with root README, drop dead language links
+- fix update command (termscp update, not --update) in READMEs
+- **zh:** fix keyring deep-link anchor to translated heading slug
+- **config:** update config dir paths for macOS/Windows in en & zh
+  > Reflect the new config directory locations (~/.config/termscp on macOS,
+  > %USERPROFILE%\.termscp on Windows) across the English and Chinese docs,
+  > and add a CLAUDE.md note to keep both translations in sync.
+
+### Fixed
+
+- **site:** robust man-fetch invocation guard, add timeout+retry
+- **site:** hero selected-row contrast (latte) + mobile row truncation
+- **site:** drop @ts-check on astro config to clear false vite type error
+- **install:** quote vars, fix set -e cargo check and rustup tmpfile cleanup
+  > - silence SC3043 by declaring dash dialect (local is supported)
+  > - quote unquoted vars (SC2086/SC1090)
+  > - fix set -e aborting arch install before cargo check
+  > - fix install_cargo removing unset $archive instead of $rustup
+  > - make brew upgrade fallback a real if-then-else (SC2015)
+  > - drop leftover starship BASE_URL and debug echo $1
+- **progress:** rework transfer progress panel (#424)
+  > Migrate the transfer progress UI to tuirealm 4, where the stdlib
+  > `ProgressBar` widget was dropped, by rebuilding the dual-bar panel on
+  > top of `Gauge`.
+  > 
+  > - Restore the unified two-bar look: the full bar (top) and partial bar
+  >   (bottom) draw joined borders so they read as a single panel; a single
+  >   file shows one fully-bordered bar.
+  > - Redraw on every file boundary in the send/recv queue loops so the
+  >   full bar's (N/total) counter advances even for small files that finish
+  >   within one in-loop redraw interval.
+  > - Track progress with a single `TransferProgress` (exact file count from
+  >   the pre-scan, lazy partial/full computation) and consolidate the theme
+  >   progress-bar fields.
+- **progress:** equalize dual progress bar heights
+  > The bottom (partial) bar carried a block title (the current filename),
+  > which forces a 1-row top inset in ratatui's `Block::inner` even though
+  > its top border is dropped to join the seam with the full bar. That left
+  > the partial bar with one inner row while the full bar kept two, so the
+  > two gauges rendered at unequal heights.
+  > 
+  > - Move the filename from the partial bar's title into its gauge label.
+  > - Skip setting an empty title so no phantom top-positioned title triggers
+  >   the inset.
+  > - Put the panel title on the top (full) bar for multi-file transfers.
+  > - Bump the two-bar popup height to fit the joined panel.
+  > 
+  > Also bump Cargo.lock and adapt the embedded terminal to the new vt100
+  > `screen_mut()` API.
+- **copy:** prevent emptying file when copy destination is empty (#421)
+  > An empty copy destination resolved to the source file's own path, so
+  > std::fs::copy truncated the original file to 0 bytes.
+  > 
+  > - localhost::copy now refuses to copy a file onto itself, returning an
+  >   error instead of truncating it (root cause).
+  > - action_copy treats an empty/whitespace destination as a cancel.
+- **transfer:** enqueue full destination path instead of directory
+  > Queued transfers stored only the destination directory as the target
+  > path. Downstream upload logic treats the queued destination as the full
+  > file path and passes it straight to create_file, so transfers failed
+  > with a Failure error when the remote target resolved to a directory.
+  > 
+  > Append each entry's file name to the destination directory at enqueue
+  > time in both enqueue_file and enqueue_all, matching the single-file
+  > transfer path which already builds the full target path.
+
+### Build
+
+- add chocolatey package, remove legacy dist build scripts
+  > The old manual dist/build/* scripts and dist/{deb,rpm}.sh are superseded by the
+  > automated release workflow. Add the chocolatey package consumed by release.yml.
+- **site:** copy install.sh from repo root at build time (single source)
+## 1.0.0
+
+Released on 2026-04-18
+
+### Added
+
+- rework TransferProgress to track bytes with lazy estimation
+- replace dual progress bar components with single TransferProgressBar
+- simplify progress bar layout to single component
+- update progress bar display for new unified data model
+- update transfer loop to use unified TransferProgress
+- consolidate theme progress bar fields into single transfer_progress_bar
+
+### CI
+
+- Codeberg mirroring
+- run test workflows once
+- check fmt with nightly toolchain
+- add linux and windows aarch64 build targets
+
+### Changed
+
+- FileTransferActivity pane-agnostic dispatch (#386)
+  > Comprehensive design for incremental refactoring of the 13k-line
+  > FileTransferActivity god-struct using a unified Pane abstraction.
+  > Detailed step-by-step plan covering 6 phases: split monoliths,
+  > error handling, Pane struct, action dedup, session split, view reorg.
+  > Extract 26 popup components from the monolithic 1,868-line popups.rs
+  > into 20 individual files under popups/. Each file contains one or two
+  > related components with their own imports. The popups.rs module file
+  > now contains only module declarations and re-exports.
+  > Replace 8 panic!() calls with error!() logging and early returns/fallthrough.
+  > These panics documented invariants (e.g. "this tab can't do X") but would crash
+  > the app if somehow triggered. Error logging is safer and more resilient.
+  > Replace raw FileExplorer fields in Browser with Pane structs that bundle
+  > the explorer and connected state. Move host_bridge_connected and
+  > remote_connected from FileTransferActivity into the panes. Add navigation
+  > API (fs_pane, opposite_pane, is_find_tab) for future unification tasks.
+  > Rename private get_selected_file to get_selected_file_by_id and add three
+  > new unified methods (get_selected_entries, get_selected_file, is_selected_one)
+  > that dispatch based on self.browser.tab(). Old per-tab methods are kept for
+  > now until their callers are migrated in subsequent tasks.
+  > Collapse _local_/_remote_ action method pairs (mkdir, delete, symlink,
+  > chmod, rename, copy) into unified methods that branch internally on
+  > is_local_tab(). This halves the number of action methods and simplifies
+  > the update.rs dispatch logic. Also unifies ShowFileInfoPopup and
+  > ShowChmodPopup dispatching to use get_selected_entries().
+  > Move `host_bridge` and `client` filesystem fields from FileTransferActivity
+  > into the Pane struct, enabling tab-agnostic dispatch via `fs_pane()`/
+  > `fs_pane_mut()`. This eliminates most `is_local_tab()` branching across
+  > 15+ action files.
+  > Key changes:
+  > - Add `fs: Box<dyn HostBridge>` to Pane, remove from FileTransferActivity
+  > - Replace per-side method pairs with unified pane-dispatched methods
+  > - Unify navigation (changedir, reload, scan, file_exists, has_file_changed)
+  > - Replace 147-line popup if/else chain with data-driven priority table
+  > - Replace assert!/panic!/unreachable! with proper error handling
+  > - Fix typo "filetransfer_activiy" across ~29 files
+  > - Add unit tests for Pane
+  > 
+  > Net result: -473 lines, single code path for most file operations.
+- replace lazy_static with std::sync::LazyLock
+- migrate from mod.rs to named module files
+- split parser internals into focused modules
+- split auth form components by protocol
+- split auth update handlers by context
+- split auth view helpers by responsibility
+
+### Documentation
+
+- date
+- add core module and API documentation
+- document core host and ssh modules
+- document parser and file transfer params
+- complete remaining core module docs
+- document ssh key storage API
+
+### Fixed
+
+- replace panics reachable from user input with proper error handling
+- replace assert! calls in UI activities with graceful error handling
+- correct typos in BadSytax and theme_provider log messages
+- replace magic-crypt with aes-gcm for bookmark encryption
+  > magic-crypt has known vulnerabilities. Replace it with aes-gcm for new
+  > encryption (authenticated, with random nonces) while keeping a legacy
+  > AES-128-CBC decryption path to transparently handle existing bookmarks.
+- replace recursive byte-counting with entry-based transfer progress (#395)
+  > * fix: replace recursive byte-counting with entry-based transfer progress
+  > 
+  > Replace the expensive recursive `get_total_transfer_size` pre-calculation
+  > with a lightweight entry-based counter (`TransferProgress`) for the
+  > overall progress bar. This avoids deep `list_dir` traversals before
+  > transfers begin, which could cause FTP idle-timeout disconnections on
+  > large directory trees.
+  > 
+  > The per-file byte-level progress bar (`ProgressStates`) remains
+  > unchanged. Bytes are still tracked via `TransferStates::add_bytes` for
+  > notification threshold logic.
+- return after empty terminal prompt
+- resolve `.` and `..` in terminal `cd` and prevent panic in path elide
+  > `absolutize` now lexically normalizes paths so `cd ..` navigates to the
+  > parent directory instead of appending `..` literally. Also guard against
+  > `file_name()` returning `None` in `fmt_path_elide_ex`, which caused a
+  > panic on paths containing unresolved `..` components.
+- pass full command string to exec, not just the first word
+  > The `Exec` arm of `Command::from_str` only captured the first
+  > whitespace-delimited token, silently dropping all arguments.
+  > Now passes the entire input string so e.g. `ls -la /tmp` works.
+- sync browsing when entering a directory from filtered/fuzzy view
+- stabilize core error handling
+  > Remove production panic and unwrap paths from core modules.
+  > 
+  > Propagate bookmark encryption failures, harden file watcher and temp mapped file handling, and clean up dead code in shared utilities.
+- normalize localhost relative path checks
+- use time-based redraw interval instead of progress-delta threshold
+  > The old 1% progress threshold caused the UI to appear frozen on large
+  > files (e.g. 1GB) because many read/write iterations passed between
+  > redraws. Switching to a 100ms time-based interval ensures consistent
+  > UI responsiveness regardless of file size.
+- render progress bar immediately after mounting
+  > Call self.view() right after mount_progress_bar() at all 6 call sites
+  > so the bar is visible on screen before the transfer loop begins.
+- filter self-references and dot entries from remote directory listings
+  > Some non-compliant FTP servers (e.g. LiteSpeed) include a self-reference
+  > to the listed directory in the LIST response, causing the current folder
+  > to appear as a duplicate entry in the explorer.
+
+### Performance
+
+- use sort_by_cached_key to avoid repeated lowercase allocations in file sorting
+
+### Testing
+
+- add parser and bookmark regression coverage
+- extend config and explorer regression coverage
+- extend system regression coverage
+
+### Build
+
+- removed `hostname`, use `whoami` instead
+  > whoami provides `hostname` function, so we don't need the hostname dependency, since whoami is also being used for getting the username
+- replaced libssh with russh for remotefs-ssh
+- replace `version-compare` crate with `semver`
+- remotefs-ssh 0.8.1
+- remotefs-ssh 0.8.2
+  > this version removes any usage of sh commands from the sftp backend and only uses pure protocol functions
+- migrate to tui-realm 4.0
+  > Upgrade tuirealm (3.x -> 4.0.0), tui-realm-stdlib (3 -> 4), tui-term
+  > (0.2 -> 0.3). Apply all breaking changes from the 4.0 migration guide
+  > across the termscp UI.
+  > 
+  > Key changes:
+  > 
+  > - Root-level re-exports removed; imports moved to module-qualified
+  >   paths (`tuirealm::application`, `::component`, `::event`, `::props`,
+  >   `::state`, `::subscription`, `::listener`, `::ratatui`). Same for
+  >   stdlib component types (`tui_realm_stdlib::components::*`).
+  > - `MockComponent` trait renamed to `Component`; old `Component` trait
+  >   renamed to `AppComponent`. `#[derive(MockComponent)]` is now
+  >   `#[derive(Component)]`. `Component::on` now takes `&Event<_>`.
+  > - `TextSpan` replaced with `SpanStatic`/`LineStatic`/`TextStatic`
+  >   (ratatui-based); tuple `(String, Alignment)` titles replaced with
+  >   the new `Title` builder; `Alignment` split into
+  >   `HorizontalAlignment`/`VerticalAlignment`; stdlib components use
+  >   `.alignment_horizontal` instead of `.alignment`.
+  > - `State::One`/`PropPayload::One` -> `Single`. `CmdResult::None`
+  >   -> `NoChange`. `Props::get_or` removed; `Props::get` now returns a
+  >   borrowed `Option<&AttrValue>` (call sites switched to
+  >   `.and_then(AttrValue::as_*)`). `Component::query` returns
+  >   `Option<QueryResult<'a>>`.
+  > - `Attribute::HighlightedColor` -> `HighlightStyle` (a full `Style`).
+  >   `.highlighted_*` helpers renamed to `.highlight_*`.
+  > - `PollStrategy::UpTo(n)` now requires a `Duration`; tick timeout moved
+  >   from `EventListenerCfg::poll_timeout` into `PollStrategy`.
+  > - `TerminalBridge` removed; `Context` now holds
+  >   `CrosstermTerminalAdapter` directly and enables raw mode + alternate
+  >   screen explicitly. The `TerminalAdapter` trait is imported where its
+  >   methods are used.
+  > - `Update` trait removed; activity `update` methods are plain inherent
+  >   functions.
+  > - `ProgressBar` replaced by stdlib `Gauge`. Paragraph `.wrap` renamed
+  >   to `.wrap_trim`; `.text` now takes an `Into<Text>`. Stdlib `List` row
+  >   items are now individual lines (`Vec<Span>` per row) rather than a
+  >   `Table` of spans; custom `FileList`/`Log` convert between the two
+  >   models.
+  > - Radio builders drop `.foreground(color)` so unselected items render
+  >   with the terminal default foreground, and set
+  >   `highlight_style(Style::default().fg(color).add_modifier(REVERSED))`
+  >   so the selected entry is visibly highlighted only with the theme
+  >   color.
+  > - Custom `FileList` keeps the selected row highlighted with the full
+  >   highlight style when focused and falls back to a foreground-only
+  >   style when unfocused.
+  > - Theme loading is now backwards compatible: `Theme` uses a custom
+  >   `Deserialize` through an intermediate `ThemeFile` with optional
+  >   fields, so missing keys, unknown values or legacy aliases
+  >   (`transfer_progress_bar_full`/`_partial`) fall back to defaults on a
+  >   per-field basis instead of failing the whole load.
+- upgrade remotefs-ssh to 0.8.3
+
+### Style
+
+- linter
+## 0.19.1
+
+Released on 2025-12-20
+
+### CI
+
+- windows artifact name
+
+### Fixed
+
+- install.sh deb name
+- install.sh deb name
+- Updated dependencies to allow build on NetBSD
+## 0.19.0
+
+Released on 2025-11-11
+
+### Added
+
+- Import bookmarks from ssh config with a CLI command (#364)
+  > * feat: Import bookmarks from ssh config with a CLI command
+  > 
+  > Use import-ssh-hosts to import all the possible hosts by the configured ssh config or the default one on your machine
+- Changed file overwrite behaviour (#366)
+  > Now the user can choose for each file whether to overwrite, skip or overwrite all/skip all.
+- Added `<CTRL+S>` keybinding to get the total size of selected paths. (#367)
+  > * feat: Added `<CTRL+S>` keybinding to get the total size of selected paths.
+- Merge branch '0.19.0'
+
+### CI
+
+- Build artifacts for Windows x86_64 and Ubuntu x86_64 (#368)
+- Debian
+- debian fix
+- deploy site
+
+### Documentation
+
+- User manual and get started links
+- Release date
+
+### Fixed
+
+- typo in file open error message (#349)
+- SMB support for MacOS with vendored build of libsmbclient.
+- Report a message while calculating total size of files to transfer. (#362)
+  > * fix: Report a message while calculating total size of files to transfer.
+  > 
+  > Currently, in case of huge transfers the app may look frozen while calculating the transfer size. We should at least report to the user we are actually doing something.
+- Issues with update checks (#363)
+  > Removed error popup message if failed to check for updates.
+  > Prevent long timeouts when checking for updates if the network is down or the DNS is not working.
+
+### Performance
+
+- Migrated to libssh.org on Linux and MacOS for better ssh agent support.
+
+### Build
+
+- 0.19 deps
+- remotefs-ssh 0.7.1
+  > This version fixes compatibility with hosts which don't use bash/sh as the default shell.
+## 0.18.0
+
+Released on 2025-06-10
+
+### Added
+
+- **Updated dependencies** and updated the Rust edition to `2024`
+- Replaced the `Exec` popup with a fully functional terminal emulator (#348)
+  > * feat: Replaced the `Exec` popup with a fully functional terminal emulator
+- 0.18
+
+### Fixed
+
+- larger file info popup
+- lock
+
+### Style
+
+- catppuccin themes
+## 0.17.0
+
+Released on 2025-03-23
+
+### Added
+
+- **cli:** added `--wno-keyring` flag to disable keyring
+- 132 queuing transfers (#332)
+  > the logic of selecting files has been extended!
+  > From now on selecting file will put the files into a transfer queue, which is shown on the bottom panel.
+  > When a file is selected the file is added to the queue with a destination path, which is the **current other explorer path at the moment of selection.
+  > It is possible to navigate to the transfer queue by using `P` and pressing `ENTER` on a file will remove it from the transfer queue.Other commands will work as well on the transfer queue, like `COPY`, `MOVE`, `DELETE`, `RENAME`.
+
+### CI
+
+- **build:** build vendored smb and refactor platform deps (#333)
+
+### Documentation
+
+- **CONTRIBUTING:** docs(CONTRIBUTING): mistakes
+- veeso.me instead of veeso.dev
+- version
+
+### Fixed
+
+- unused import isolated tests
+- isolated-tests for localhost
+- clippy error
+- **ui:** fixed input mask on host bridge on local dir up
+  > if you go up on local dir when localhost is selected it panics
+- fixed a crash when the local directory specified in the auth form does not exist
+- the return value of `--version` should be `0`
+- **aws-s3:** updated remotefs-aws-s3 to 0.4.1
+  > should fix #329
+- **log:** add suppaftp/pavao/kube to allowed logs
+- **bookmarks:** Local directory path is not switching to what's specified in the bookmark
+
+### Testing
+
+- **remotefs_builder:** check result, build doesn't panic anymore
+
+### Build
+
+- **deps:** updated dependencies and edition to 2024
+- bump to ssh2-config 0.4 and remotefs 0.6 to have support for Include in config files
+- aws-s3 0.4.2
+- build docker for x86
+- so apparently native-tls vendored tries to build openssl on windows, wtf guys?
+## 0.16.1
+
+Released on 2024-11-12
+
+### Fixed
+
+- cfg unix forbidden in rust .82
+- gg rust 1.82 for introducing a nice breaking change in config which was not mentioned in changelog
+- 0.16.1
+## 0.16.0
+
+Released on 2024-10-14
+
+### Added
+
+- version 0.16
+- Show `..` directory before all the others in the explorer to navigate to the parent dir (#301)
+
+### Fixed
+
+- Use `uzers` instead of the dead package `users` which has several vulnerabilities (#295)
+- vergen (#296)
+- users from lock
+- tuirealm 2.x (#299)
+- issue 292 New version alert was not displayed due to a semver regex issue. (#300)
+- 0.16
+- tiny ui issue
+## 0.15.0
+
+Released on 2024-10-03
+
+### Added
+
+- init 0.15
+- Pods and container explorer for Kube protocol (#281)
+- it is now possible to cancel find command; show find progress (#284)
+
+### Fixed
+
+- tokio rt builder
+- dbus deveL
+- bump vers
+- keyring test not passing macos
+- notify 6
+- bump vers
+- don't clear screen after terminating termscp
+- issue 277 Fix a bug in the configuration page, which caused being stuck if the added SSH key was empty
+- popup texts
+- `isolated-tests` feature to run tests for releasing on distributions which run in isolated environments (#286)
+  > * fix: `isolated-tests` feature to run tests for releasing on distributions which run in isolated environments
+  > 
+  > * fix: cond
+- set date
+- github ci is stable and reliable (one worker broken each 2 weeks)
+- ci
+- readme
+- include build.rs
+## 0.14.0
+
+Released on 2024-07-17
+
+### Added
+
+- ALT+A to deselect all files (#263)
+- ssh-agent (#264)
+- issue 256 - filter files (#266)
+- kube protocol support (#267)
+- termscp 0.14
+
+### Documentation
+
+- update Arch Linux instructions (#243)
+
+### Fixed
+
+- install script version
+- correct help text for update subcommand (#259)
+- lint
+- CLI remote args cannot handle '@' in the username (#261)
+- sorted flags in readme
+- Jump to next entry after select (#262)
+- remotefs-ssh 0.3.1
+- german manual
+- removed support for RPM
+- changelog
+## 0.13.0
+
+Released on 2024-03-02
+
+### Added
+
+- WebDAV support (#235)
+- termscp 0.13.0
+
+### Fixed
+
+- AWS S3 wasn't working anymore due to rust-s3 outdate
+- test
+- debian script
+- debian script
+- lint???
+## 0.12.2
+
+Released on 2023-10-01
+
+### Added
+
+- tui-realm 1.9
+
+### Fixed
+
+- fmt
+- panic if the terminal screen is too small
+## 0.12.1
+
+Released on 2023-07-06
+
+### Added
+
+- smb is now an optional feature (#200)
+- build artifacts workflow (#202)
+
+### Fix
+
+- Some URL typos on 'install.sh' and 'README.md'. (#197)
+
+### Fixed
+
+- install workflow
+- sh compliant macos.sh build script
+- readme site links
+- better main runner
+- deps
+- don't run CI on site/.md change
+- rustup target
+- don't update path breadcrumb if enter/scan dir failed (#203)
+## 0.12.0
+
+Released on 2023-05-16
+
+### Added
+
+- allow unknown fields in ssh2 configuration file (#181)
+
+### Fixed
+
+- #153 show a loading message when loading directory's content (#180)
+- specify ssh2 config params
+- release date
+- build
+- pavao 0.2.2
+- pavao 0.2.3
+- macos script
+- release date
+## 0.11.3
+
+Released on 2023-04-19
+
+### Added
+
+- site improvements
+
+### Fixed
+
+- relative paths windows (#167)
+## 0.11.2
+
+Released on 2023-04-18
+
+### Added
+
+- dependencies up-to-date
+- site 0.11.2
+## 0.8.1
+
+Released on 2022-03-22
+
+### Fixed
+
+- footer listed "Delete" shortcut as "Make Dir"
+## 0.8.0
+
+Released on 2022-01-06
+
+### Arch
+
+- install rust only if not found on local system
+## 0.7.0
+
+Released on 2021-10-12
+
+### Option
+
+- prompt user when about to replace an existing file caused by a file transfer
+## 0.6.1
+
+Released on 2021-08-30
+
+### Fixed
+
+- When copying files with tricky copy, the upper progress bar shows no text
+## 0.5.1
+
+Released on 2021-06-21
+
+### Fix
+
+- target_family unix means also macos and linux; use BSD target_os
+## 0.5.0
+
+Released on 2021-05-23
+
+### Coverage
+
+- githubActions
+- githubActions
+
+### Grcov
+
+- exclude activities
+## 0.4.1
+
+Released on 2021-04-06
+
+### FTP
+
+- transfer type set to binary
+- added support for symlinks for Linux servers
+
+### Readme
+
+- one-liner for Homebrew
+  > The one-liner command
+  > 
+  >   brew install veeso/termscp/termscp
+  > 
+  > is equivalent to the two commands
+  > 
+  >   brew tap veeso/termscp
+  >   brew install termscp
+
+### SCP
+
+- fixed symlink not properly detected
+## 0.4.0
+
+Released on 2021-03-27
+
+### Clippy
+
+- don't allow warnings
+
+### Codecov
+
+- ignore activities, context, input but not layout/
+
+### PropsBuilder
+
+- use from trait
+
+### View
+
+- return String instead of id
+## 0.3.3
+
+Released on 2021-02-28
+
+### Git
+
+- check for new updates (utils)
+## 0.3.2
+
+Released on 2021-01-24
+
+### Testing
+
+- don't run on windows
+## 0.3.0
+
+Released on 2021-01-10
+
+### AuthActivity
+
+- enter setup with <CTRL+C>
+
+### ConfigClient
+
+- return key path, not content
+
+### Docs
+
+- private keys with passwords
+
+### Explorers
+
+- append '/' to directories name
+
+### FileTransferActivity
+
+- load ConfigClient; set text editor to configuration's value
+- :Explorer refactoring; toggle hidden files with <A>
+- sort files with <B>
+
+### FsEntry
+
+- :get_name() returns &str
+- :is_hidden() method
+
+### SetupActivity
+
+- <CTRL+E> as <DEL>
+## 0.2.0
+
+Released on 2020-12-21
+
+### FsEntry
+
+- :is_file
+
+### Scp
+
+- when username was not provided, it didn't fallback to current username
+## 0.1.2
+
+Released on 2020-12-13
+
+### FsEntry
+
+- :*::symlink is now a Option<Box<FsEntry>>; this improved symlinks, which gave errors some times
 ## 0.1.0
 
-Released on 06/12/2020
+Released on 2020-12-06
 
-- First release
+### FileTransferActivity
+
+- ftp is now allowed
+
+### Host
+
+- :mkdir and Host::remove
+- mkdir support for absolute path
+
+### Scp
+
+- use oneshot channels instead of ptys (more stable; more reliable and overall works)
+
+### Std
+
+- :fmt::Display for HostError
+- :fmt::Display for HostError

CLAUDE.md

@@ -0,0 +1,111 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+termscp is a terminal file transfer client with a TUI (Terminal User Interface), supporting SFTP, SCP, FTP/FTPS, Kube, S3, SMB, and WebDAV protocols. It features a dual-pane file explorer (local + remote), bookmarks, system keyring integration, file watching/sync, an embedded terminal, and customizable themes.
+
+- **Language**: Rust (edition 2024, MSRV 1.89.0)
+- **UI Framework**: tuirealm v3 (built on crossterm)
+- **File Transfer**: remotefs ecosystem
+
+## Build & Development Commands
+
+```bash
+# Build
+cargo build
+cargo build --release
+cargo build --no-default-features              # minimal build without SMB/keyring
+
+# Test (CI-equivalent)
+cargo test --no-default-features --features github-actions --no-fail-fast
+
+# Run a single test
+cargo test <test_name> -- --nocapture
+
+# Run tests for a module
+cargo test --lib filetransfer::
+cargo test --lib config::params::tests
+
+# Lint
+cargo clippy -- -Dwarnings
+
+# Format
+cargo fmt --all -- --check      # check only
+cargo fmt --all                 # fix
+```
+
+### System Dependencies (for building)
+
+- **Linux**: `libdbus-1-dev`, `libsmbclient-dev`
+- **macOS**: `pkg-config`, `samba` (brew, with force link)
+
+## Feature Flags
+
+- **`smb`** (default): SMB/Samba protocol support
+- **`keyring`** (default): System keyring integration for password storage
+- **`smb-vendored`**: Vendored SMB library (for static builds)
+- **`github-actions`**: CI flag — disables real keyring in tests, uses file-based storage
+- **`isolated-tests`**: For parallel test isolation
+
+## Architecture
+
+### Application Lifecycle
+
+```
+main.rs → parse CLI args → ActivityManager::new() → ActivityManager::run()
+                                                        ↓
+                                              Activity loop (draw → poll → update)
+                                              ├── AuthActivity (login/bookmarks)
+                                              ├── FileTransferActivity (dual-pane explorer)
+                                              └── SetupActivity (configuration)
+```
+
+`ActivityManager` owns a `Context` that is passed between activities. Each activity takes ownership of the Context on `on_create()` and returns it on `on_destroy()`.
+
+### Key Modules
+
+| Module | Path | Purpose |
+|--------|------|---------|
+| **activity_manager** | `src/activity_manager.rs` | Orchestrates activity lifecycle and transitions |
+| **ui/activities** | `src/ui/activities/{auth,filetransfer,setup}/` | Three main screens, each implementing the `Activity` trait |
+| **ui/context** | `src/ui/context.rs` | Shared `Context` struct (terminal, config, bookmarks, theme) |
+| **filetransfer** | `src/filetransfer/` | Protocol enum, `RemoteFsBuilder`, connection parameters |
+| **host** | `src/host/` | `HostBridge` trait — abstracts local (`Localhost`) and remote (`RemoteBridged`) file operations |
+| **explorer** | `src/explorer/` | `FileExplorer` — directory navigation, sorting, filtering, transfer queue |
+| **system** | `src/system/` | `BookmarksClient`, `ConfigClient`, `ThemeProvider`, `SshKeyStorage`, `KeyStorage` trait |
+| **config** | `src/config/` | TOML-based serialization for themes, bookmarks, user params |
+
+### Core Traits
+
+- **`Activity`** (`src/ui/activities/mod.rs`): `on_create`, `on_draw`, `will_umount`, `on_destroy` — UI screen lifecycle
+- **`HostBridge`** (`src/host/bridge.rs`): Unified file operations interface (connect, list_dir, open_file, mkdir, remove, rename, copy, etc.)
+- **`KeyStorage`** (`src/system/keys/mod.rs`): `get_key`/`set_key` — password storage abstraction (keyring or encrypted file fallback)
+
+### Conditional Compilation
+
+The `build.rs` defines cfg aliases via `cfg_aliases`:
+- `posix`, `macos`, `linux`, `win` — platform shortcuts
+- `smb`, `smb_unix`, `smb_windows` — feature + platform combinations
+
+Platform-specific dependencies: SSH and FTP crates use different TLS backends on Unix vs Windows. SMB support is completely gated behind the `smb` feature flag.
+
+### File Transfer Protocols
+
+`FileTransferProtocol` enum maps to protocol-specific parameter types (`ProtocolParams` enum) and `RemoteFsBuilder` constructs the appropriate `RemoteFs` client. Each protocol has its own params struct (e.g., `GenericProtocolParams` for SSH-based, `AwsS3Params`, `KubeProtocolParams`, `SmbParams`, `WebDAVProtocolParams`).
+
+## Code Conventions
+
+- **rustfmt**: `group_imports = "StdExternalCrate"`, `imports_granularity = "Module"`
+- **Error handling**: Custom error types with `thiserror`, module-level Result aliases (e.g., `HostResult<T>`)
+- **Builder pattern**: Used for `RemoteFsBuilder`, `HostBridgeBuilder`
+- **Client pattern**: System services wrapped as clients (`BookmarksClient`, `ConfigClient`)
+- **Tests**: Unit tests in `#[cfg(test)]` blocks within source files. Tests requiring serial execution use `#[serial]` from `serial_test`
+- **Encryption**: Bookmark passwords encrypted with `magic-crypt`; keys stored in system keyring or encrypted file
+
+## Other conventions
+
+- Always run `cargo +nightly fmt --all` and `cargo clippy --no-default-features -- -Dwarnings` after modifying Rust code
+- Always put plans to `./.claude/plans/`
+- When changing behavior that is documented under `docs/` (paths, config keys, commands, flags, etc.), update BOTH `docs/en-US/` and `docs/zh-CN/` to keep the translations in sync

CODE_OF_CONDUCT.md

@@ -2,75 +2,131 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at christian.visintin1997@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
 [homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-<https://www.contributor-covenant.org/faq>
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -1,15 +1,107 @@
 # Contributing
 
 Before contributing to this repository, please first discuss the change you wish to make via issue of this repository before making a change.
-Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+Please note we have a [code of conduct](CODE_OF_CONDUCT.md). Please follow it in all your interactions with the project.
 
 - [Contributing](#contributing)
+  - [Project mission](#project-mission)
+    - [Project goals](#project-goals)
+  - [Open an issue](#open-an-issue)
+    - [Questions](#questions)
+    - [Bug reports](#bug-reports)
+    - [Copy error](#copy-error)
+    - [Feature requests](#feature-requests)
   - [Preferred contributions](#preferred-contributions)
   - [Pull Request Process](#pull-request-process)
+    - [Software guidelines](#software-guidelines)
   - [Developer contributions guide](#developer-contributions-guide)
-    - [How TermSCP works](#how-termscp-works)
-      - [Activities](#activities)
-    - [Implementing File Transfers](#implementing-file-transfers)
+
+---
+
+## Project mission
+
+termscp was born because, as a terminal lover and Linux user, I wanted something like WinSCP on Linux and on terminal. At my previous job, I used SFTP/SCP practically everyday and that made me desire an application like termscp so much that eventually I started to work on it in my spare time.
+
+I saw there was a very cool library to create terminal user interfaces (`tui-rs`, now `ratatui`), so I started to code it.
+
+I wrote termscp as an experiment. I didn't design anything at the time. I just said,
+
+> "Ok, there must be a FileTransfer trait somehow. I'll have more views, so I'll use something like Android activities, and there must be a module to interact with the local host."
+
+And so in december 2020 I had the first version of termscp running and it worked, but was very simple, raw and minimal.
+A lot of things have changed since them, both the features the project provides and my personal view of this project.
+
+Today I don't see termscp as a WinSCP clone anymore. I've also thought about changing the name as the time passed by, but I liked it and it would be hard to change the name on the registries, etc.
+
+Right now I see termscp as a **rich-featured file transfer client for terminals**. All I want is to provide all the features users need to use it correctly, I want it to be **safe and reliable** and eventually I want people to consider termscp **the first choice as a file transfer client**.
+
+### Project goals
+
+- Have support for all the most used file transfer protocol
+- Provide all the features a file explorer requires
+- Have a well designed application
+- Make a reliable, safe and fast application
+
+---
+
+## Open an issue
+
+Open an issue when:
+
+- You have questions or concerns regarding the project or the application itself.
+- You have a bug to report.
+- You have a copy error to report. (Error in documentation; bad translation or sentence)
+- You have a feature or a suggestion to improve termscp to submit.
+
+### Questions
+
+If you have a question open an issue using the `Question` template.
+By default your question should already be labeled with the `question` label, if you need help with your installation, please also add the `help wanted` label.
+Check the issue is always assigned to `veeso`.
+
+### Bug reports
+
+If you want to report an issue or a bug you've encountered while using termscp, open an issue using the `Bug report` template.
+The `Bug` label should already be set and the issue should already be assigned to `veeso`.
+Don't set other labels to your issue, not even priority.
+
+When you open a bug try to be the most precise as possible in describing your issue. I'm not saying you should always be that precise, since sometimes it's very easy for maintainers to understand what you're talking about. Just try to be reasonable to understand sometimes we might not know what you're talking about or we just don't have the technical knowledge you might think.
+Please always provide the environment you're working on and consider that we don't provide any support for older version of termscp, at least for those not classified as LTS (if we'll ever have them).
+If you can, provide the log file or the snippet involving your issue. You can find in the [user manual](https://docs.termscp.rs/en-US/configuration/logging.html) the location of the log file. Please, if you can, enable the **debug mode**, before submitting the log, in order to provide us with a better overview of the problem.
+Last but not least: the template I've written must be used. Full stop.
+
+Maintainers will may add additional labels to your issue:
+
+- **duplicate**: the issue is duplicated; the reference to the related issue will be added to your description. Your issue will be closed.
+- **priority**: this must be fixed asap
+- **sorcery**: it is not possible to find out what's causing your bug, nor is reproducible on our test environments.
+- **wontfix**: your bug has a very high ratio between the difficulty to fix it and the probability to encounter it, or it just isn't a bug, but a feature.
+
+### Copy error
+
+If you want to report a copy error, create an issue using the `copy` template.
+The `Documentation` label should already be set and the issue should already be assigned to `veeso`.
+
+If you want to fix the copy by yourself you can fork the project and open a PR, otherwise I will fix it by myself.
+The copy issue is accepted **also if you're not a C1/C2 speaker**, but a speaker of that level in case the language is different from Italian/English is preferred.
+Please fullfil the form on the bottom of the template if you want.
+
+### Feature requests
+
+Whenever you have a good idea which chould improve the project, it is a good idea to submit it to the project owner.
+The first thing you should do though, is not starting to write the code, but is to become concern about how termscp works, what kind
+of contribution I appreciate and what kind of contribution I won't consider.
+Said so, follow these steps:
+
+- Read the contributing guidelines, entirely
+- Think on whether your idea would fit in the project mission and guidelines or not
+- Think about the impact your idea would have on the project
+- Open an issue using the `feature request` template describing with accuracy your suggestion
+- Wait for the maintainer feedback on your idea
+
+It is very important to follow these steps, since it will prevent you from working on a feature that will be rejected and trust me, none of us wants to deal with this situation.
+
+Always mind that your suggestion, may be rejected: I'll always provide a feedback on the reasons that brought me to reject your feature, just try not to get mad about that.
 
 ---
 
@@ -17,191 +109,44 @@ Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it
 
 At the moment, these kind of contributions are more appreciated and should be preferred:
 
-- Fix for issues described in [Known Issues](./README.md#known-issues) or [issues reported by the community](https://github.com/ChristianVisintin/TermSCP/issues)
-- New file transfers: for further details see [Implementing File Transfer](#implementing-file-transfers)
-- Improvements to translators: any improvement to transliteration is accepted if makes sense, consider that my implementations could be not 100% correct (and probably they're not), indeed consider that I don't speak all these languages (tbh I only can speak Russian as a language with a different alphabet from latin - and I can't even speak it very well).
-- Code optimizations: any optimization to the code is welcome
+- Fix for issues described in [Known Issues](./README.md#known-issues-) or [issues reported by the community](https://github.com/veeso/termscp/issues)
+- **New file transfers**: for further details see [Implementing File Transfer](#implementing-file-transfers). ⚠️ this is going to be deprecated SOON! We're moving the file transfers into another library. Please see [remotefs-rs](https://github.com/veeso/remotefs-rs).
+- **Code optimizations**: any optimization to the code is welcome
+- See also features described in [Upcoming features](./README.md##upcoming-features-). Open an issue first though.
+- README/User manual **translations**: really appreciated atm. Please just add a folder into `docs/` with the language code. Language code with two characters is used in case the language is understandable by all the countries where this language is spoken (e.g. `it-CH`, `it-IT` are not really different, so I just created `it`, but there is a big difference from `zh-CN` and `zh-TW` for instance). Don't worry about flags in README, I will implement that part if it's too complicated.
 
-For any other kind of contribution, especially for new features, please submit an issue first.
+For any other kind of contribution, especially for new features, please submit a new issue first.
 
 ## Pull Request Process
 
 Let's make it simple and clear:
 
-1. Open an issue with an **appropriate label** (e.g. bug, enhancement, ...).
-2. Write a **properly documentation** compliant with **rustdoc** standard.
-3. Write tests for your code. This doesn't apply necessarily for implementation regarding the user-interface module (`ui`).
-4. Report changes to the issue you opened, writing a report of what you changed and what you have introduced.
-5. Update the `CHANGELOG.md` file with details of changes to the application.
-6. Request maintainers to merge your changes.
+1. Open a PR with an **appropriate label** (e.g. bug, enhancement, ...).
+2. Write a **properly documentation** for your software compliant with **rustdoc** standard.
+3. Write tests for your code. This doesn't apply necessarily for implementation regarding the user-interface module (`ui/activities`) and (if a test server is not available) for file transfers.
+4. Check your code with `cargo clippy`.
+5. Check if the CI for your commits reports three-green.
+6. Report changes to the PR you opened, writing a report of what you changed and what you have introduced.
+7. Update the `CHANGELOG.md` file with details of changes to the application. In changelog report changes under a chapter called `PR{PULL_REQUEST_NUMBER}` (e.g. PR12).
+8. Assign a maintainer to the reviewers.
+9. Wait for a maintainer to fullfil the acceptance tests
+10. Wait for a maintainer to complete the acceptance tests
+11. Request maintainers to merge your changes.
+
+### Software guidelines
+
+In addition to the process described for the PRs, I've also decided to introduce a list of guidelines to follow when writing the code, that should be followed:
+
+1. **Let's stop the NPM apocalypse**: personally I'm against the abuse of dependencies we make in software projects and I think that NodeJS has opened the way to this drama (and has already gone too far). Nowadays nobody cares about adding hundreds of dependencies to their projects. Don't misunderstand me: I think that package managers are cool, but I'm totally against the abuse we're making of them. I think when we work on a project, we should try to use the minor quantity of dependencies as possible, especially because it's not hard to see how many libraries are getting abandoned right now, causing compatibility issues after a while. So please, when working on termscp, try not to add useless dependencies.
+2. **No C-bindings**: personally I think that Rust still relies too much on C. And that's bad, really bad. Many libraries in Rust are just wrappers to C libraries, which is a huge problem, especially considering this is a multiplatform project. Everytime you add a C-binding to your project, you're forcing your users to install additional libraries to their systems. Sometimes these libraries are already installed on their systems (as happens for openssl in this case), but sometimes not. So if you really have to add a dependency to this project, please AVOID completely adding C-bounded libraries.
+3. **Test units matter**: Whenever you implement something new to this project, always implement test units which cover the most cases as possible.
+4. **Comments are useful**: Many people say that the code should be that simple to talk by itself about what it does, and comments should then be useless. I personally don't agree. I'm not saying they're wrong, but I'm just saying that this approach has, in my personal opinion, many aspects which are underrated:
+   1. What's obvious for me, might not be for the others.
+   2. Our capacity to work on a code depends mostly on **time and experience**, not on complexity: I'm not denying complexity matter, but the most decisive factor when working on code is the experience we've acquired working on it and the time we've spent. As the author of the project, I know the project like the back of my hands, but if I didn't work on it for a year, then I would probably have some problems in working on it again as the same speed as before. And do you know what's really time-saving in these cases? Comments.
 
 ## Developer contributions guide
 
-Welcome to the contributions guide for TermSCP. This chapter DOESN'T contain the documentation for TermSCP, which can instead be found on Rust Docs at <https://docs.rs/termscp>
-This chapter describes how TermSCP works and the guide lines to implement stuff such as file transfers and add features to the user interface.
-
-### How TermSCP works
-
-TermSCP is basically made up of 4 components:
-
-- the **filetransfer**: the filetransfer takes care of managing the remote file system; it provides function to establish a connection with the remote, operating on the remote server file system (e.g. remove files, make directories, rename files, ...), read files and write files. The FileTransfer, as we'll see later, is actually a trait, and for each protocol a FileTransfer must be implement the trait.
-- the **host**: the host module provides functions to interact with the local host file system.
-- the **ui**: this module contains the implementation of the user interface, as we'll see in the next chapter, this is achieved through **activities**.
-- the **activity_manager**: the activity manager takes care of managing activities, basically it runs the activities of the user interface, and chooses, based on their state, when is the moment to terminate the current activity and which activity to run after the current one.
-
-#### Activities
-
-Just a little paragraph about activities. Really, read the code and the documentation to have a clear idea of how the ui works.
-I think there are many ways to implement a user interface; for termscp, I decided to go for a **Android-like** approach.
-Android works with Activity, each activity represents a view and there is a context shared between them, and so it works here.
-
-Just a little note about activities, activities work with a `Context`, the context is a data holder for different data, which are shared and common between the activities.
-
-I've implemented a Trait called `Activity`, which, is a very very reduced version of the Android activity of course.
-This trait provides only 3 methods:
-
-- `on_create`: this method must initialize the activity; the context is passed to the activity, which will be the only owner of the Context, until the activity terminates.
-- `on_draw`: this method must be called each time you want to perform an update of the user interface. This is basically the run method of the activity. This method also cares about handling input events. The developer shouldn't draw the interface on each call of this method (consider that this method might be called hundreds of times per second), but only when actually something has changed (for example after an input event has been raised).
-- `on_destroy`: this method finalizes the activity and drops it; this method returns the Context to the caller (the activity manager).
-
----
-
-### Implementing File Transfers
-
-This chapter describes how to implement a file transfer in TermSCP. A file transfer is a module which implements the `FileTransfer` trait. The file transfer provides different modules to interact with a remote server, which in addition to the most obvious methods, used to download and upload files, provides also methods to list files, delete files, create directories etc.
-
-In the following steps I will describe how to implement a new file transfer, in this case I will be implementing the SCP file transfer (which I'm actually implementing the moment I'm writing this lines).
-
-1. Add the Scp protocol to the `FileTransferProtocol` enum.
-
-    Move to `src/filetransfer/mod.rs` and add `Scp` to the `FileTransferProtocol` enum
-
-    ```rs
-    /// ## FileTransferProtocol
-    ///
-    /// This enum defines the different transfer protocol available in TermSCP
-    #[derive(std::cmp::PartialEq, std::fmt::Debug, std::clone::Clone)]
-    pub enum FileTransferProtocol {
-        Sftp,
-        Ftp(bool), // Bool is for secure (true => ftps)
-        Scp, // <-- here
-    }
-    ```
-
-    In this case Scp is a "plain" enum type. If you need particular options, follow the implementation of `Ftp` which uses a boolean flag for indicating if using FTPS or FTP.
-
-2. Implement the FileTransfer struct
-
-    Create a file at `src/filetransfer/mytransfer.rs`
-
-    Declare your file transfer struct
-
-    ```rs
-    /// ## ScpFileTransfer
-    ///
-    /// SFTP file transfer structure
-    pub struct ScpFileTransfer {
-        session: Option<Session>,
-        sftp: Option<Sftp>,
-        wrkdir: PathBuf,
-    }
-    ```
-
-3. Implement the `FileTransfer` trait for it
-
-    You'll have to implement the following methods for your file transfer:
-
-    - connect: connect to remote server
-    - disconnect: disconnect from remote server
-    - is_connected: returns whether the file transfer is connected to remote
-    - pwd: get working directory
-    - change_dir: change working directory.
-    - list_dir: get files and directories at a certain path
-    - mkdir: make a new directory. Return an error in case the directory already exists
-    - remove: remove a file or a directory. In case the protocol doesn't support recursive removing of directories you MUST implement this through a recursive algorithm
-    - rename: rename a file or a directory
-    - stat: returns detail for a certain path
-    - send_file: opens a stream to a remote path for write purposes (write a remote file)
-    - recv_file: opens a stream to a remote path for read purposes (write a local file)
-    - on_sent: finalize a stream when writing a remote file. In case it's not necessary just return `Ok(())`
-    - on_recv: fianlize a stream when reading a remote file. In case it's not necessary just return `Ok(())`
-
-    In case the protocol you're working on doesn't support any of this features, just return `Err(FileTransferError::new(FileTransferErrorType::UnsupportedFeature))`
-
-4. Add your transfer to filetransfers:
-
-    Move to `src/filetransfer/mod.rs` and declare your file transfer:
-
-    ```rs
-    // Transfers
-    pub mod ftp_transfer;
-    pub mod scp_transfer; // <-- here
-    pub mod sftp_transfer;
-    ```
-
-5. Handle FileTransfer in `FileTransferActivity::new`
-
-    Move to `src/ui/activities/filetransfer_activity/mod.rs` and add the new protocol to the client match
-
-    ```rs
-    client: match protocol {
-        FileTransferProtocol::Sftp => Box::new(SftpFileTransfer::new()),
-        FileTransferProtocol::Ftp(ftps) => Box::new(FtpFileTransfer::new(ftps)),
-        FileTransferProtocol::Scp => Box::new(ScpFileTransfer::new()), // <--- here
-    },
-    ```
-
-6. Handle right/left input events in `AuthActivity`:
-
-    Move to `src/ui/activities/auth_activity.rs` and handle the new protocol in `handle_input_event_mode_text` for `KeyCode::Left` and `KeyCode::Right`.
-    Consider that the order they "rotate" must match the way they will be drawned in the interface.
-    For newer protocols, please put them always at the end of the list. In this list I won't, because Scp is more important than Ftp imo.
-
-    ```rs
-    KeyCode::Left => {
-        // If current field is Protocol handle event... (move element left)
-        if self.selected_field == InputField::Protocol {
-            self.protocol = match self.protocol {
-                FileTransferProtocol::Sftp => FileTransferProtocol::Ftp(true), // End of list (wrap)
-                FileTransferProtocol::Scp => FileTransferProtocol::Sftp,
-                FileTransferProtocol::Ftp(ftps) => match ftps {
-                    false => FileTransferProtocol::Scp,
-                    true => FileTransferProtocol::Ftp(false),
-                }
-            };
-        }
-    }
-    KeyCode::Right => {
-        // If current field is Protocol handle event... ( move element right )
-        if self.selected_field == InputField::Protocol {
-            self.protocol = match self.protocol {
-                FileTransferProtocol::Sftp => FileTransferProtocol::Scp,
-                FileTransferProtocol::Scp => FileTransferProtocol::Ftp(false),
-                FileTransferProtocol::Ftp(ftps) => match ftps {
-                    false => FileTransferProtocol::Ftp(true),
-                    true => FileTransferProtocol::Sftp, // End of list (wrap)
-                }
-            };
-        }
-    }
-    ```
-
-7. Add your new file transfer to the protocol input field
-
-    Move to `AuthActivity::draw_protocol_select` method.
-    Here add your new protocol to the `Spans` vector and to the match case, which chooses which element to highlight.
-
-    ```rs
-    let protocols: Vec<Spans> = vec![Spans::from("SFTP"), Spans::from("SCP"), Spans::from("FTP"), Spans::from("FTPS")];
-    let index: usize = match self.protocol {
-        FileTransferProtocol::Sftp => 0,
-        FileTransferProtocol::Scp => 1,
-        FileTransferProtocol::Ftp(ftps) => match ftps {
-            false => 2,
-            true => 3,
-        }
-    };
-    ```
+You can view the developer guide [here](https://docs.termscp.rs/en-US/developer/developer.html).
 
 ---
 

Cargo.toml

@@ -1,47 +1,17 @@
 [package]
 name = "termscp"
-version = "0.1.0"
-authors = ["Christian Visintin"]
-edition = "2018"
-license = "GPL-3.0"
-keywords = ["scp-client", "sftp-client", "ftp-client", "winscp", "command-line-utility"]
+version = "1.1.0"
+edition = "2024"
+authors = ["Christian Visintin <christian.visintin@veeso.dev>"]
+description = "termscp is a feature rich terminal file transfer and explorer with support for SCP/SFTP/FTP/Kube/S3/WebDAV"
+license = "MIT"
+repository = "https://github.com/veeso/termscp"
 categories = ["command-line-utilities"]
-description = "TermSCP is a SCP/SFTP/FTPS client for command line with an integrated UI to explore the remote file system. Basically WinSCP on a terminal."
-homepage = "https://github.com/ChristianVisintin/TermSCP"
-repository = "https://github.com/ChristianVisintin/TermSCP"
-documentation = "https://docs.rs/termscp"
+homepage = "https://termscp.rs"
+include = ["src/**/*", "build.rs", "LICENSE", "README.md", "CHANGELOG.md"]
+keywords = ["terminal", "ftp", "scp", "sftp", "tui"]
 readme = "README.md"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-crossterm = "0.18.2"
-ftp4 = { version = "^4.0.0", features = ["secure"] }
-getopts = "0.2.21"
-ssh2 = "0.9.0"
-tui = { version = "0.13.0", features = ["crossterm"], default-features = false }
-whoami = "1.0.0"
-rpassword = "5.0.0"
-unicode-width = "0.1.7"
-chrono = "0.4.19"
-bytesize = "1.0.1"
-textwrap = "0.12.1"
-regex = "1.4.2"
-lazy_static = "1.4.0"
-hostname = "0.3.1"
-
-[target.'cfg(any(unix, macos, linux))'.dependencies]
-users = "0.11.0"
-
-[dev-dependencies]
-tempfile = "3"
-
-#[patch.crates-io]
-#ftp = { git = "https://github.com/ChristianVisintin/rust-ftp" }
-
-[[bin]]
-name = "termscp"
-path = "src/main.rs"
+rust-version = "1.89.0"
 
 [package.metadata.rpm]
 package = "termscp"
@@ -51,3 +21,128 @@ buildflags = ["--release"]
 
 [package.metadata.rpm.targets]
 termscp = { path = "/usr/bin/termscp" }
+
+[package.metadata.deb]
+maintainer = "Christian Visintin <christian.visintin@veeso.dev>"
+copyright = "2025, Christian Visintin <christian.visintin@veeso.dev>"
+extended-description-file = "docs/misc/README.deb.txt"
+
+[features]
+default = ["keyring", "smb"]
+github-actions = []
+isolated-tests = []
+keyring = []
+smb = ["dep:remotefs-smb"]
+smb-vendored = ["remotefs-smb/vendored"]
+
+[dependencies]
+aes = "0.9"
+aes-gcm = "0.10"
+argh = "0.1"
+base64 = "0.22"
+bitflags = "2"
+bytesize = "2"
+cbc = { version = "0.2", features = ["alloc"] }
+chrono = "0.4"
+content_inspector = "0.2"
+dirs = "6"
+edit = "0.1"
+filetime = "0.2"
+keyring-core = "1"
+lazy-regex = "3"
+log = "0.4"
+md-5 = "0.11"
+notify = "8"
+notify-rust = { version = "4", default-features = false, features = ["d"] }
+nucleo = "0.5"
+open = "5"
+rand = "0.10"
+regex = "1"
+remotefs = "0.3"
+remotefs-aws-s3 = "0.4"
+remotefs-kube = "0.4"
+remotefs-smb = { version = "0.3", optional = true }
+remotefs-ssh = { version = "0.8", default-features = false, features = [
+  "russh",
+] }
+remotefs-webdav = "0.2"
+rpassword = "7"
+self_update = { version = "0.42", default-features = false, features = [
+  "archive-tar",
+  "archive-zip",
+  "compression-flate2",
+  "compression-zip-deflate",
+  "rustls",
+] }
+semver = "1"
+serde = { version = "1", features = ["derive"] }
+shellexpand = "3"
+simplelog = "0.12"
+ssh2-config = "0.7"
+tempfile = "3"
+thiserror = "2"
+tokio = { version = "1", features = ["rt"] }
+toml = "1"
+tui-realm-stdlib = "4"
+tui-term = "0.3"
+tuirealm = "4"
+unicode-width = "0.2"
+whoami = "2"
+wildmatch = "2"
+
+[target."cfg(any(target_os = \"linux\", target_os = \"freebsd\"))".dependencies]
+dbus-secret-service-keyring-store = { version = "1", features = [
+  "crypto-rust",
+  "vendored",
+] }
+
+[target."cfg(target_family = \"unix\")".dependencies]
+remotefs-ftp = { version = "0.4", features = [
+  "native-tls",
+  "native-tls-vendored",
+] }
+uzers = "0.12"
+
+[target."cfg(target_family = \"windows\")".dependencies]
+remotefs-ftp = { version = "0.4", features = ["native-tls"] }
+
+[target."cfg(target_os = \"macos\")".dependencies]
+apple-native-keyring-store = { version = "1", features = ["keychain"] }
+
+[target."cfg(target_os = \"windows\")".dependencies]
+windows-native-keyring-store = "1"
+
+[dev-dependencies]
+pretty_assertions = "1"
+serial_test = "3"
+
+[build-dependencies]
+cfg_aliases = "0.2"
+vergen-git2 = { version = "10", features = ["build", "cargo", "rustc", "si"] }
+
+[[bin]]
+name = "termscp"
+path = "src/main.rs"
+
+[lints.rust]
+trivial_numeric_casts = "warn"
+unsafe_op_in_unsafe_fn = "warn"
+unused_lifetimes = "warn"
+
+[lints.clippy]
+complexity = { level = "warn", priority = -1 }
+correctness = { level = "warn", priority = -1 }
+cloned_instead_of_copied = "warn"
+implicit_clone = "warn"
+manual_string_new = "warn"
+perf = { level = "warn", priority = -1 }
+redundant_closure_for_method_calls = "warn"
+style = { level = "warn", priority = -1 }
+suspicious = { level = "warn", priority = -1 }
+unnested_or_patterns = "warn"
+
+[profile.dev]
+incremental = true
+
+[profile.release]
+strip = true

LICENSE

@@ -1,674 +1,21 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    TermSCP
-    Copyright (C) 2020  Christian Visintin
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    TermSCP  Copyright (C) 2020  Christian Visintin
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+MIT License
+
+Copyright (c) 2020-2022 Christian Visintin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,269 +1,220 @@
-# TermSCP
+# termscp
 
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Stars](https://img.shields.io/github/stars/ChristianVisintin/TermSCP.svg)](https://github.com/ChristianVisintin/TermSCP) [![Issues](https://img.shields.io/github/issues/ChristianVisintin/TermSCP.svg)](https://github.com/ChristianVisintin/TermSCP/issues) [![Downloads](https://img.shields.io/crates/d/termscp.svg)](https://crates.io/crates/termscp) [![Crates.io](https://img.shields.io/badge/crates.io-v0.1.0-orange.svg)](https://crates.io/crates/termscp) [![Docs](https://docs.rs/termscp/badge.svg)](https://docs.rs/termscp)  
+<p align="center">
+  <img src="/assets/images/termscp.svg" alt="termscp logo" width="256" height="256" />
+</p>
 
-[![Build](https://github.com/ChristianVisintin/TermSCP/workflows/Linux/badge.svg)](https://github.com/ChristianVisintin/TermSCP/actions) [![Build](https://github.com/ChristianVisintin/TermSCP/workflows/MacOS/badge.svg)](https://github.com/ChristianVisintin/TermSCP/actions) [![Build](https://github.com/ChristianVisintin/TermSCP/workflows/Windows/badge.svg)](https://github.com/ChristianVisintin/TermSCP/actions)
+<p align="center">~ A feature rich terminal file transfer ~</p>
+<p align="center">
+  <a href="https://termscp.rs" target="_blank">Website</a>
+  ·
+  <a href="https://termscp.rs/install" target="_blank">Installation</a>
+  ·
+  <a href="https://docs.termscp.rs" target="_blank">User manual</a>
+</p>
 
-~ Basically, WinSCP on a terminal ~  
-Developed by Christian Visintin  
-Current version: 0.1.0 (06/12/2020)
+<p align="center">
+  <a
+    href="/docs/zh-CN/README.md"
+    ><img
+      height="20"
+      src="/assets/images/flags/cn.png"
+      alt="简体中文"
+  /></a>
+</p>
+
+<p align="center">Developed by <a href="https://veeso.me/" target="_blank">@veeso</a></p>
+
+[![License-MIT](https://img.shields.io/crates/l/termscp.svg?logo=rust)](https://opensource.org/licenses/MIT)
+[![Repostars](https://img.shields.io/github/stars/veeso/termscp?style=flat&logo=github)](https://github.com/veeso/termscp/stargazers)
+[![Downloadscounter](https://img.shields.io/crates/d/termscp.svg?logo=rust)](https://crates.io/crates/termscp)
+[![Latest version](https://img.shields.io/crates/v/termscp.svg?logo=rust)](https://crates.io/crates/termscp)
+[![CI](https://github.com/veeso/termscp/workflows/CI/badge.svg?logo=github)](https://github.com/veeso/termscp/actions/workflows/ci.yml)
 
 ---
 
-- [TermSCP](#termscp)
-  - [About TermSCP 🖥](#about-termscp-)
-    - [Why TermSCP 🤔](#why-termscp-)
-  - [Features 🎁](#features-)
-  - [Installation ▶](#installation-)
-    - [Cargo 🦀](#cargo-)
-    - [Deb package 📦](#deb-package-)
-    - [RPM Package 📦](#rpm-package-)
-    - [Chocolatey 🍫](#chocolatey-)
-    - [Brew 🍻](#brew-)
-  - [Usage ❓](#usage-)
-    - [Address argument](#address-argument)
-      - [How Password can be provided](#how-password-can-be-provided)
-  - [Keybindings ⌨](#keybindings-)
-  - [Documentation 📚](#documentation-)
-  - [Known issues 🧻](#known-issues-)
-  - [Upcoming Features 🧪](#upcoming-features-)
-  - [Contributions 🤙🏻](#contributions-)
-  - [Changelog ⏳](#changelog-)
-  - [Powered by 🚀](#powered-by-)
-  - [Gallery 🎬](#gallery-)
-  - [License 📃](#license-)
+## About termscp 🖥
 
----
-
-## About TermSCP 🖥
-
-TermSCP is basically a porting of WinSCP to terminal. So basically is a terminal utility with an TUI to connect to a remote server to retrieve and upload files and to interact with the local file system. It works both on **Linux**, **MacOS**, **UNIX** and **Windows** and supports SFTP, SCP, FTP and FTPS.
+Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/Kube/S3/WebDAV. So basically is a terminal utility with an TUI to connect to a remote server to retrieve and upload files and to interact with the local file system. It is **Linux**, **MacOS**, **FreeBSD**, **NetBSD** and **Windows** compatible.
 
 ![Explorer](assets/images/explorer.gif)
 
 ---
 
-### Why TermSCP 🤔
-
-It happens very often to me, when using SCP at work to forget the path of a file on a remote machine, which forces me then to connect through SSH, gather the file path and finally download it through SCP. I could use WinSCP, but I use Linux and I pratically use the terminal for everything, so I wanted something like WinSCP on my terminal. Yeah, I know there midnight commander too, but actually I don't like it very much tbh (and doesn't support scp).
-
 ## Features 🎁
 
-- Different communication protocols
-  - SFTP
-  - SCP
-  - FTP and FTPS
-- Practical user interface to explore and operate on the remote and on the local machine file system
-- Compatible with Windows, Linux, UNIX and MacOS
-- Written in Rust
-- Easy to extend with new file transfers protocols
+- 📁  Different communication protocols
+  - **SFTP**
+  - **SCP**
+  - **FTP** and **FTPS**
+  - **Kube**
+  - **S3**
+  - **SMB**
+  - **WebDAV**
+- 🖥  Explore and operate on the remote and on the local machine file system with a handy UI
+  - Create, remove, rename, search, view and edit files
+- ⭐  Connect to your favourite hosts through built-in bookmarks and recent connections
+- 📝  View and edit files with your favourite applications
+- 💁  SFTP/SCP authentication with SSH keys and username/password
+- 🐧  Compatible with Windows, Linux, FreeBSD, NetBSD and MacOS
+- 🐚  Embedded terminal for executing commands on the system.
+- 🎨  Make it yours!
+  - Themes
+  - Custom file explorer format
+  - Customizable text editor
+  - Customizable file sorting
+  - and many other parameters...
+- 📫  Get notified via Desktop Notifications when a large file has been transferred
+- 🔭  Keep file changes synchronized with the remote host
+- 🔐  Save your password in your operating system key vault
+- 🦀  Rust-powered
+- 👀  Developed keeping an eye on performance
+- 🦄  Frequent awesome updates
 
 ---
 
-## Installation ▶
+## Get started 🚀
 
-If you're considering to install TermSCP I want to thank you 💛 ! I hope you will enjoy TermSCP!  
-If you want to contribute to this project, don't forget to check out our contribute guide. [Read More](CONTRIBUTING.md)
+If you're considering to install termscp I want to thank you 💜 ! I hope you will enjoy termscp!  
+If you want to contribute to this project, don't forget to check out our [contribute guide](CONTRIBUTING.md).
 
-### Cargo 🦀
+If you are a Linux, a FreeBSD or a MacOS user this simple shell script will install termscp on your system with a single command:
 
 ```sh
-# Install termscp through cargo
-cargo install termscp
+curl --proto '=https' --tlsv1.2 -sSLf https://termscp.rs/install.sh | sh
 ```
 
-### Deb package 📦
+> ❗ MacOs installation requires [Homebrew](https://brew.sh/), otherwise the Rust compiler will be installed
 
-Get `deb` package from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp_0.1.0_amd64.deb)
-or run `wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp_0.1.0_amd64.deb`
+if you're a Windows user, you can install termscp from PowerShell with a single command:
 
-then install through dpkg:
-
-```sh
-dpkg -i termscp_*.deb
-# Or even better with gdebi
-gdebi termscp_*.deb
+```ps
+irm https://termscp.rs/install.ps1 | iex
 ```
 
-### RPM Package 📦
-
-Get `rpm` package from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp-0.1.0-1.x86_64.rpm)
-or run `wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp-0.1.0-1.x86_64.rpm`
-
-then install through rpm:
-
-```sh
-rpm -U termscp_*.rpm
-```
-
-### Chocolatey 🍫
-
-You can install TermSCP on Windows using [chocolatey](https://chocolatey.org/)
-
-Start PowerShell as administrator and run
+or, alternatively, with [Chocolatey](https://chocolatey.org/):
 
 ```ps
 choco install termscp
 ```
 
-Alternatively you can download the ZIP file from [HERE](https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp.0.1.0.nupkg)
-
-and then with PowerShell started with administrator previleges, run:
-
-```ps
-choco install termscp -s .
-```
-
-### Brew 🍻
-
-You can install TermSCP on MacOS using [brew](https://brew.sh/)
-
-From your terminal run
+NetBSD users can install termscp from the official repositories.
 
 ```sh
-brew tap ChristianVisintin/termscp
-brew install termscp
+pkgin install termscp
 ```
 
----
+Arch Linux users can install termscp from the official repositories.
 
-## Usage ❓
-
-TermSCP can be started with the following options:
-
-- `-P, --password <password>` if address is provided, password will be this argument
-- `-v, --version` Print version info
-- `-h, --help` Print help page
-
-TermSCP can be started in two different mode, if no extra arguments is provided, TermSCP will show the authentication form, where the user will be able to provide the parameters required to connect to the remote peer.
-
-Alternatively, the user can provide an address as argument to skip the authentication form and starting directly the connection to the remote server.
-
-### Address argument
-
-The address argument has the following syntax:
-
-```txt
-[protocol]://[username@]<address>[:port]
+```sh
+pacman -S termscp
 ```
 
-Let's see some example of this particular syntax, since it's very comfortable and you'll probably going to use this instead of the other one...
+For more information or other platforms, please visit [termscp.rs](https://termscp.rs/install) to view all installation methods.
 
-- Connect using default protocol (sftp) to 192.168.1.31, port is default for this protocol (22); username is current user's name
+⚠️ If you're looking on how to update termscp just run termscp from CLI with: `(sudo) termscp update` ⚠️
 
-    ```sh
-    termscp 192.168.1.31
-    ```
+### Requirements ❗
 
-- Connect using default protocol (sftp) to 192.168.1.31, port is default for this protocol (22); username is `root`
+- **Linux** users:
+  - libdbus-1
+  - pkg-config
+  - libsmbclient
+- **FreeBSD** or, **NetBSD** users:
+  - dbus
+  - pkgconf
+  - libsmbclient
 
-    ```sh
-    termscp root@192.168.1.31
-    ```
+### Optional Requirements ✔️
 
-- Connect using scp to 192.168.1.31, port is 4022; username is `omar`
+These requirements are not forced required to run termscp, but to enjoy all of its features
 
-    ```sh
-    termscp scp://omar@192.168.1.31:4022
-    ```
-
-#### How Password can be provided
-
-You have probably noticed, that, when providing the address as argument, there's no way to provide the password.
-Password can be basically provided through 3 ways when address argument is provided:
-
-- `-P, --password` option: just use this CLI option providing the password. I strongly unrecommend this method, since it's very unsecure (since you might keep the password in the shell history)
-- Via `sshpass`: you can provide password via `sshpass`, e.g. `sshpass -f ~/.ssh/topsecret.key termscp cvisintin@192.168.1.31`
-- You will be prompted for it: if you don't use any of the previous methods, you will be prompted for the password, as happens with the more classics tools such as `scp`, `ssh`, etc.
+- **Linux/FreeBSD** users:
+  - To **open** files via `V` (at least one of these)
+    - *xdg-open*
+    - *gio*
+    - *gnome-open*
+    - *kde-open*
+- **Linux** users:
+  - A keyring manager: read more in the [User manual](https://docs.termscp.rs/en-US/configuration/password-security.html#linux-keyring)
+- **WSL** users
+  - To **open** files via `V` (at least one of these)
+    - [wslu](https://github.com/wslutilities/wslu)
 
 ---
 
-## Keybindings ⌨
+## User manual 📚
 
-| Key           | Command                                               |
-|---------------|-------------------------------------------------------|
-| `<ESC>`       | Disconnect from remote; return to authentication page |
-| `<TAB>`       | Switch between log tab and explorer                   |
-| `<BACKSPACE>` | Go to previous directory in stack                     |
-| `<RIGHT>`     | Move to remote explorer tab                           |
-| `<LEFT>`      | Move to local explorer tab                            |
-| `<UP>`        | Move up in selected list                              |
-| `<DOWN>`      | Move down in selected list                            |
-| `<PGUP>`      | Move up in selected list by 8 rows                    |
-| `<PGDOWN>`    | Move down in selected list by 8 rows                  |
-| `<ENTER>`     | Enter directory                                       |
-| `<SPACE>`     | Upload / download selected file                       |
-| `<CTRL+D>`    | Make directory                                        |
-| `<CTRL+G>`    | Go to supplied path                                   |
-| `<CTRL+H>`    | Show help                                             |
-| `<CTRL+Q>`    | Quit TermSCP                                          |
-| `<CTRL+R>`    | Rename file                                           |
-| `<CTRL+U>`    | Go to parent directory                                |
-| `<CANC>`      | Delete file                                           |
-
----
-
-## Documentation 📚
-
-The developer documentation can be found on Rust Docs at <https://docs.rs/termscp>
-
----
-
-## Known issues 🧻
-
-- Ftp:
-  - Time in explorer is `1 Jan 1970`, but shouldn't be: that's because chrono can't parse date in a different locale. So if your server has a locale different from the one on your machine, it won't be able to parse the date.
-  - Some servers don't work: yes, some kind of ftp server don't work correctly, sometimes it won't display any files in the directories, some other times uploading files will fail. Up to date, `vsftpd` is the only one server which I saw working correctly with TermSCP. Am I going to solve this? I'd like to, but it's not my fault at all. Unfortunately [rust-ftp](https://github.com/mattnenterprise/rust-ftp) is an abandoned project (up to 2020), indeed I had to patch many stuff by myself. I'll try to solve these issues, but it will take a long time.
-- Sftp:
-  - sftp is much slower than scp: Okay this is an annoying issue, and again: not my fault. It seems there is an issue with [ssh2-rs](https://github.com/alexcrichton/ssh2-rs) library. If you want to stay up to date with the status of this issue, subscribe to [this issue](https://github.com/alexcrichton/ssh2-rs/issues/206)
-- `NoSuchFileOrDirectory` on connect: let me guess, you're running on WSL and you've installed termscp through cargo. I know about this issue and it's a glitch of WSL I guess. Don't worry about it, just move the termscp executable into another PATH location, such as `/usr/bin`.
+The user manual can be found on [termscp's documentation website](https://docs.termscp.rs).
 
 ---
 
 ## Upcoming Features 🧪
 
-- **File viewer**: possibility to show in a popup the file content from the explorer.
+See [Milestones](https://github.com/veeso/termscp/milestones)
 
 ---
 
-## Contributions 🤙🏻
+## Contributing and issues 🤝🏻
 
-Contributions are welcome! 😉
+Contributions, bug reports, new features and questions are welcome! 😉
+If you have any question or concern, or you want to suggest a new feature, or you want just want to improve termscp, feel free to open an issue or a PR.
 
-If you think you can contribute to TermSCP, please follow [TermSCP's contributions guide](CONTRIBUTING.md)
+An **appreciated** contribution would be a translation of the user manual and readme in **other languages**
+
+Please follow [our contributing guidelines](CONTRIBUTING.md)
+
+---
 
 ## Changelog ⏳
 
-View TermSCP's changelog [HERE](CHANGELOG.md)
+View termscp's changelog [HERE](CHANGELOG.md)
 
 ---
 
-## Powered by 🚀
+## Powered by 💪
 
-TermSCP is powered by these aweseome projects:
+termscp is powered by these awesome projects:
 
 - [bytesize](https://github.com/hyunsik/bytesize)
 - [crossterm](https://github.com/crossterm-rs/crossterm)
+- [edit](https://github.com/milkey-mouse/edit)
+- [keyring-rs](https://github.com/hwchen/keyring-rs)
+- [kube](https://github.com/kube-rs/kube)
+- [open-rs](https://github.com/Byron/open-rs)
+- [pavao](https://github.com/veeso/pavao)
+- [remotefs](https://github.com/veeso/remotefs-rs)
 - [rpassword](https://github.com/conradkleinespel/rpassword)
-- [ssh2-rs](https://github.com/alexcrichton/ssh2-rs)
-- [textwrap](https://github.com/mgeisler/textwrap)
-- [tui-rs](https://github.com/fdehau/tui-rs)
+- [self_update](https://github.com/jaemk/self_update)
+- [ratatui](https://github.com/ratatui-org/ratatui)
+- [tui-realm](https://github.com/veeso/tui-realm)
 - [whoami](https://github.com/libcala/whoami)
+- [wildmatch](https://github.com/becheran/wildmatch)
 
 ---
 
 ## Gallery 🎬
 
+> Termscp Home
+
 ![Auth](assets/images/auth.gif)
 
+> Bookmarks
+
+![Bookmarks](assets/images/bookmarks.gif)
+
+> Setup
+
+![Setup](assets/images/config.gif)
+
+> Text editor
+
+![TextEditor](assets/images/text-editor.gif)
+
 ---
 
 ## License 📃
 
-Licensed under the GNU GPLv3 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
-
-<http://www.gnu.org/licenses/gpl-3.0.txt>
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+termscp is licensed under the MIT license.
 
 You can read the entire license [HERE](LICENSE)

SECURITY.md

@@ -0,0 +1,10 @@
+# Security Policy
+
+## Supported Versions
+
+Only latst version of termscp has the latest security updates.
+Because of that, **you should always consider updating termscp to the latest version**.
+
+## Reporting a Vulnerability
+
+If you have any security vulnerability or concern to report, please open an issue using the `Security report` template.

assets/images/termscp.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 500 500"><circle style="fill:#31363b" cx="250" cy="250" r="250"/><circle style="fill:#ea4444" cx="225" cy="40" r="7.344"/><circle style="fill:#eac944" cx="58.177" cy="22.745" r="7.344" transform="matrix(1, 0, 0, 1.031863, 191.822998, 16.530386)"/><circle style="fill:#34b938" cx="57.564" cy="22.269" r="7.344" transform="matrix(1, 0, 0, 1.031863, 217.43605, 17.021263)"/><polygon style="stroke:#000;fill:#f0f0f0" points="83.462 135.575 200 252.112 87.687 364.425 48.108 324.846 122.07 250.881 45.738 174.55"/><g transform="matrix(0.408921, 0, 0, 0.408921, 241.338654, 169.687912)"><polygon style="fill:#f0f0f0" points="196.4 0 292 49.2 388 98 292 147.2 196.4 196.4 100.8 147.2 4.8 98 100.8 49.2"/><polygon style="fill:#31363b" points="316 179.6 316 135.2 268 159.6 268 204 294.4 171.6"/><polygon style="fill:#f0f0f0" points="196.4 196.4 196.4 392.8 388 294.8 388 98 316 135.2 314.4 136 314.4 179.2 294.4 171.6 268 204 268 159.6"/><polygon style="fill:#f0f0f0" points="196.4 392.8 196.4 196.4 100.8 147.2 4.8 98 4.8 294.8"/><polygon style="fill:#31363b" points="76.8 61.2 268 159.6 314.4 136 316 135.2 124.8 36.8 100.8 49.2"/></g><rect style="fill:#f0f0f0" width="200" height="35.702" x="222.229" y="364.298" rx="10" ry="10"/></svg>

build.rs

@@ -0,0 +1,33 @@
+use cfg_aliases::cfg_aliases;
+use vergen_git2::{Build, Cargo, Emitter, Git2, Rustc, Sysinfo};
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // Setup cfg aliases
+    cfg_aliases! {
+        // Platforms
+        macos: { target_os = "macos" },
+        linux: { target_os = "linux" },
+        posix: { target_family = "unix" },
+        win: { target_family = "windows" },
+        // exclusive features
+        smb: { feature = "smb" },
+        smb_unix: { all(unix, feature = "smb") },
+        smb_windows: { all(windows, feature = "smb") }
+    }
+
+    let build = Build::all_build();
+    let cargo = Cargo::all_cargo();
+    let git2 = Git2::all_git();
+    let rustc = Rustc::all_rustc();
+    let si = Sysinfo::all_sysinfo();
+
+    Emitter::default()
+        .add_instructions(&build)?
+        .add_instructions(&cargo)?
+        .add_instructions(&git2)?
+        .add_instructions(&rustc)?
+        .add_instructions(&si)?
+        .emit()?;
+
+    Ok(())
+}

cliff.toml

@@ -0,0 +1,46 @@
+[changelog]
+body = """
+## {{ version | trim_start_matches(pat="v") }}
+
+Released on {{ timestamp | date(format="%Y-%m-%d") }}
+{%- if commits | filter(attribute="breaking", value=true) | length > 0 %}
+
+### ⚠ Breaking Changes
+
+{%- for commit in commits | filter(attribute="breaking", value=true) %}
+- {% if commit.scope %}**{{ commit.scope }}:** {% endif %}{{ commit.message | split(pat="\n") | first | trim }}
+  {%- if commit.breaking_description %}
+  > {{ commit.breaking_description }}
+  {%- endif %}
+{%- endfor %}
+{%- endif %}
+{%- for group, commits in commits | group_by(attribute="group") %}
+
+### {{ group | upper_first }}
+{% for commit in commits %}
+- {% if commit.breaking %}💥 {% endif %}{% if commit.scope %}**{{ commit.scope }}:** {% endif %}{{ commit.message | split(pat="\n") | first | trim }}
+  {%- if commit.body %}
+  > {{ commit.body | split(pat="\n") | join(sep="\n  > ") }}
+  {%- endif %}
+{%- endfor %}
+{%- endfor %}
+"""
+trim = false
+
+[git]
+conventional_commits = true
+filter_unconventional = true
+split_commits = false
+commit_parsers = [
+  { message = "^feat", group = "Added" },
+  { message = "^fix", group = "Fixed" },
+  { message = "^refactor", group = "Changed" },
+  { message = "^perf", group = "Performance" },
+  { message = "^doc", group = "Documentation" },
+  { message = "^test", group = "Testing" },
+  { message = "^ci", group = "CI" },
+  { message = "^chore", skip = true },
+]
+filter_commits = false
+tag_pattern = "v[0-9].*"
+sort_commits = "oldest"

dist/chocolatey/README.md

@@ -0,0 +1,8 @@
+# Chocolatey How To
+
+Just:
+
+1. Calculate the SHA256 checksum for the latest release of ZIP files both for aarch64 and x86_64 versions.
+2. Update checksums in `tools/chocolateyinstall.ps1`
+3. run `choco pack`
+4. run `choco push termscp.$VERSION.nupkg --source https://push.chocolatey.org/`

dist/chocolatey/termscp.nuspec

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
+  <metadata>
+    <id>termscp</id>
+    <version>1.1.0</version>
+    <title>termSCP</title>
+    <authors>Christian Visintin</authors>
+    <owners>Christian Visintin</owners>
+    <projectUrl>https://veeso.github.io/termscp/</projectUrl>
+    <copyright>Christian Visintin (C) 2024</copyright>
+    <licenseUrl>https://github.com/veeso/TermSCP/blob/main/LICENSE</licenseUrl>
+    <iconUrl>https://rawcdn.githack.com/veeso/termscp/c3e5663cf45c4d6a7b50c8b15f89683a2e01b829/assets/images/termscp-512.png</iconUrl>
+    <requireLicenseAcceptance>true</requireLicenseAcceptance>
+    <projectSourceUrl>https://github.com/veeso/termscp/tree/main/src</projectSourceUrl>
+    <packageSourceUrl>https://github.com/veeso/termscp</packageSourceUrl>
+    <releaseNotes>https://github.com/veeso/termscp/blob/main/CHANGELOG.md</releaseNotes>
+    <docsUrl>https://docs.rs/termscp</docsUrl>
+    <bugTrackerUrl>https://github.com/veeso/termscp/issues</bugTrackerUrl>
+    <tags>termscp winscp rust rust-lang rust-crate scp ssh-client ssh sftp-client ftp-client ftps utility terminal-app terminal command-line-utility command-line-tool tui-rs winscp sftp</tags>
+    <summary>A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/Kube/WebDAV/S3</summary>
+    <description>
+## About TermSCP
+
+Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/S3. So basically is a terminal utility with an TUI to connect to a remote server to retrieve and upload files and to interact with the local file system. It is **Linux**, **MacOS**, **BSD** and **Windows** compatible and supports SFTP, SCP, FTP and FTPS.
+
+Features:
+
+- 📁  Different communication protocols
+  - SFTP
+  - Kube
+  - WebDAV
+  - SCP
+  - FTP and FTPS
+  - S3
+  - SMB
+- 🖥  Explore and operate on the remote and on the local machine file system with a handy UI
+  - Create, remove, rename, search, view and edit files
+- ⭐  Connect to your favourite hosts through built-in bookmarks and recent connections
+- 📝  View and edit text files with your favourite text editor
+- 💁  SFTP/SCP authentication through SSH keys and username/password
+- 🐧  Compatible with Windows, Linux, BSD and MacOS
+- ✏  Customizable
+  - Themes
+  - Custom file explorer format
+  - Customizable text editor
+  - Customizable file sorting
+- 🔐  Save your password in your operating system key vault
+- 🦀  Rust-powered
+- 🤝  Easy to extend with new file transfers protocols
+- 👀  Developed keeping an eye on performance
+- 🦄  Frequent awesome updates
+    </description>
+  </metadata>
+  <files>
+    <file src="tools/**" target="tools" />
+  </files>
+</package>

dist/chocolatey/tools/chocolateyinstall.ps1

@@ -0,0 +1,25 @@
+$ErrorActionPreference = 'Stop';
+$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
+
+# Detect arch: PROCESSOR_ARCHITECTURE is "ARM64" on ARM, "AMD64" on x64
+$is_arm64 = $env:PROCESSOR_ARCHITECTURE -eq 'ARM64' -or $env:PROCESSOR_ARCHITEW6432 -eq 'ARM64'
+
+if ($is_arm64) {
+    $url      = 'https://github.com/veeso/termscp/releases/download/v1.1.0/termscp-v1.1.0-msvc.zip'
+    $checksum = 'f6ad6c62f1578562f9af4bcee93bd4cc429cb52219c3636359b008db8789587e'
+} else {
+    $url      = 'https://github.com/veeso/termscp/releases/download/v1.1.0/termscp-v1.1.0-x86_64-pc-windows-msvc.zip'
+    $checksum = 'd7796081b6f67b82acfa94557aa6852d12a33daab3cca6490660b20e42752005'
+}
+
+$packageArgs = @{
+    packageName    = $env:ChocolateyPackageName
+    fileType       = 'EXE'
+    url            = $url
+    unzipLocation  = $toolsDir
+    softwareName   = 'termscp*'
+    checksum       = $checksum
+    checksumType   = 'sha256'
+    validExitCodes = @(0, 3010, 1641)
+}
+Install-ChocolateyZipPackage @packageArgs

dist/deb.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-echo "Installing cargo-deb..."
-cargo install cargo-deb
-if [ ! -f "Cargo.toml" ]; then
-    echo "Yout must be in the project root directory"
-    exit 1
-fi
-echo "Running cargo-deb"
-cargo deb
-exit $?

dist/release/bump_version.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+# Bump termscp version across all tracked locations.
+# Usage: bump_version.sh <version> [date] [root]
+set -euo pipefail
+
+VERSION="${1:?usage: bump_version.sh <version> [date] [root]}"
+DATE="${2:-$(date +%F)}"
+ROOT="${3:-$(git rev-parse --show-toplevel)}"
+
+# in-place sed that works on both GNU and BSD/macOS
+sedi() { perl -0777 -pi -e "$1" "$2"; }
+
+# Cargo.toml — only the top-level package version (line-anchored), not deps
+sedi "s/^version = \"[0-9][0-9A-Za-z.\\-]*\"/version = \"$VERSION\"/m" "$ROOT/Cargo.toml"
+
+# install.sh — the literal default assignment only
+sedi "s/^TERMSCP_VERSION=\"[0-9][0-9A-Za-z.\\-]*\"/TERMSCP_VERSION=\"$VERSION\"/m" "$ROOT/install.sh"
+
+# install.ps1 — the default -Version parameter value only
+sedi "s/\\\$Version = \"[0-9][0-9A-Za-z.\\-]*\"/\\\$Version = \"$VERSION\"/" "$ROOT/install.ps1"
+
+# README.md — version + release date
+sedi "s/Current version: [0-9][0-9A-Za-z.\\-]* [0-9]{4}-[0-9]{2}-[0-9]{2}/Current version: $VERSION $DATE/" "$ROOT/README.md"
+
+# site: version constant displayed on the website
+sedi "s/^export const VERSION = \"[0-9][0-9A-Za-z.\\-]*\";/export const VERSION = \"$VERSION\";/m" "$ROOT/site/src/consts.ts"
+
+# chocolatey nuspec
+sedi "s#<version>[0-9][0-9A-Za-z.\\-]*</version>#<version>$VERSION</version>#" "$ROOT/dist/chocolatey/termscp.nuspec"
+
+# chocolatey install script — release tag + asset name in the URLs (checksums set later by CI)
+sedi "s#releases/download/v[0-9][0-9A-Za-z.\\-]*/termscp-v[0-9][0-9A-Za-z.\\-]*-#releases/download/v$VERSION/termscp-v$VERSION-#g" "$ROOT/dist/chocolatey/tools/chocolateyinstall.ps1"
+
+echo "Bumped to $VERSION ($DATE)"

dist/release/test_bump_version.sh

@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+BUMP="$SCRIPT_DIR/bump_version.sh"
+
+ROOT="$(mktemp -d)"
+trap 'rm -rf "$ROOT"' EXIT
+
+# --- build a fixture tree mirroring the real layout, all at 1.0.0 ---
+mkdir -p "$ROOT/site/html" "$ROOT/site/lang" "$ROOT/dist/chocolatey/tools"
+
+cat > "$ROOT/Cargo.toml" <<'EOF'
+[package]
+name = "termscp"
+version = "1.0.0"
+
+[dependencies]
+foo = { version = "1.0.0" }
+EOF
+
+cat > "$ROOT/install.sh" <<'EOF'
+TERMSCP_VERSION="1.0.0"
+set_termscp_version() {
+    TERMSCP_VERSION="$1"
+}
+EOF
+
+cat > "$ROOT/README.md" <<'EOF'
+<p align="center">Current version: 1.0.0 2026-04-18</p>
+EOF
+
+cat > "$ROOT/site/html/home.html" <<'EOF'
+<span>termscp 1.0.0 is NOW out! Download it from</span>
+EOF
+
+cat > "$ROOT/site/html/get-started.html" <<'EOF'
+<a href="https://github.com/veeso/termscp/releases/latest/download/termscp.1.0.0.nupkg">Github</a>
+<pre>wget -O termscp.deb https://github.com/veeso/termscp/releases/latest/download/termscp_1.0.0_amd64.deb</pre>
+EOF
+
+for lang in en it fr es zh-CN; do
+  cat > "$ROOT/site/lang/$lang.json" <<'EOF'
+{ "versionAlert": "termscp 1.0.0 is NOW out! Download it from" }
+EOF
+done
+
+cat > "$ROOT/dist/chocolatey/termscp.nuspec" <<'EOF'
+<version>1.0.0</version>
+EOF
+
+cat > "$ROOT/dist/chocolatey/tools/chocolateyinstall.ps1" <<'EOF'
+$url = 'https://github.com/veeso/termscp/releases/download/v1.0.0/termscp-v1.0.0-aarch64-pc-windows-msvc.zip'
+$url = 'https://github.com/veeso/termscp/releases/download/v1.0.0/termscp-v1.0.0-x86_64-pc-windows-msvc.zip'
+EOF
+
+# --- run the bump ---
+"$BUMP" 1.1.0 2026-06-07 "$ROOT"
+
+fail() { echo "FAIL: $1"; exit 1; }
+have() { grep -q -- "$2" "$ROOT/$1" || fail "$1 missing: $2"; }
+missing() { ! grep -q -- "$2" "$ROOT/$1" || fail "$1 still has: $2"; }
+
+# package version bumped, dependency version NOT touched
+have  "Cargo.toml" 'version = "1.1.0"'
+have  "Cargo.toml" 'foo = { version = "1.0.0" }'
+
+have  "install.sh" 'TERMSCP_VERSION="1.1.0"'
+have  "README.md" 'Current version: 1.1.0 2026-06-07'
+missing "README.md" '2026-04-18'
+
+have  "site/html/home.html" 'termscp 1.1.0 is NOW out'
+have  "site/lang/en.json" 'termscp 1.1.0 is NOW out'
+have  "site/lang/zh-CN.json" 'termscp 1.1.0 is NOW out'
+have  "site/html/get-started.html" 'termscp.1.1.0.nupkg'
+have  "site/html/get-started.html" 'termscp_1.1.0_amd64.deb'
+have  "dist/chocolatey/termscp.nuspec" '<version>1.1.0</version>'
+have  "dist/chocolatey/tools/chocolateyinstall.ps1" 'releases/download/v1.1.0/termscp-v1.1.0-'
+missing "dist/chocolatey/tools/chocolateyinstall.ps1" 'v1.0.0'
+
+# --- idempotency: running again at same version is a no-op (no error) ---
+"$BUMP" 1.1.0 2026-06-07 "$ROOT"
+have "Cargo.toml" 'version = "1.1.0"'
+
+echo "PASS"

dist/rpm.sh

@@ -1,16 +0,0 @@
-#!/bin/bash
-
-which rpmbuild > /dev/null
-if [ $? -ne 0 ]; then
-    echo "You must install rpmbuild on your machine"
-fi
-echo "Installing cargo-rpm..."
-cargo install cargo-rpm
-if [ ! -f "Cargo.toml" ]; then
-    echo "Yout must be in the project root directory"
-    exit 1
-fi
-echo "Running cargo-rpm"
-cargo rpm init
-cargo rpm build
-exit $?

docs/CNAME

@@ -0,0 +1 @@
+docs.termscp.rs

docs/drawio/UI.drawio

@@ -1 +0,0 @@
-<mxfile host="Electron" modified="2020-11-21T19:08:13.709Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.3.1 Chrome/83.0.4103.119 Electron/9.0.5 Safari/537.36" etag="CH09h_mpCNwCuwQp3CzT" version="13.3.1" type="device" pages="2"><diagram id="SlpWaeKyUTlHltKKkHdB" name="ScpActivity">7ZlRk5owEMc/DY/HABGEx2rv2pnWmXaczj3nJEKmgdAQD+yn7wJBoOhUrbbcTHwx2SSb5L+/4EoMtEzKDwJn8YqHhBmOFZYGem84ju26FnxVln1j8QO3MUSChqpTZ1jTn0QZ1bhoR0OSDzpKzpmk2dC44WlKNnJgw0LwYthty9lw1gxHZGRYbzAbW59pKGO1C2fe2T8SGsXtzLYXNC0JbjurneQxDnnRM6FHAy0F57IpJeWSsEq8Vpdm3NOJ1sPCBEnlOQOyRbEsv31ixSv+vi6c588r9vXBaby8YrZTG1aLlftWAcF3aUgqJ5aBFkVMJVlneFO1FhBzsMUyYVCzobiljC054wLqKU+h00LNQIQk5cml2wdBgCTCEyLFHrqoAchEqBmzH9JRdCFBgWd6KipxLyJopvpiRUJ0cN+JBQWl1wXaoTeh3azl77R0M8s6pptj+t6dpJsdkc5jMPPiBQqRrLfeGLYc9tkX1fux423DQ14/MN5BB9Ck7BpbL1+qU6g8wUobZ8MJwNyb9MYBxIxGKVQZ2crbxBMo9/58Fo4E1L3XOXB1MK8/nO60YumNYvlEGUlxQkBVnFQapS95Vu/e+semGo8b+seS3nZbGREJzXPK0/w6H7xIiahTIb7L3gC+o2fR/Bi/8Os9GyPs3QvhuUZYI3x1ejQFgn1NsCb4fILNwA96H3+YUaAJAB1ooDXQl2QVbh/o+RDoYAJAt3m6JloT/ddEH/7N/VeibU20JvqStNm0+p/f3klNIeuwxy+3NdIa6bNflE8i0RhfMmiGNcOnGbaHqcYUM43x5c+K5Hl1D+tYL7y8m8wbEBGi2Vw2rJV/u603N8+Oe6NAmEEwkB55Y+l92zUteyz94clzgfZQ7a6S67behTx6/AU=</diagram><diagram id="SK1VvSCf6-f5suE94Ksw" name="AuthActivity">5ZfRbpswFIafhstIAQNtL1OarlI1qUq6RdrNZLADnowPs00ge/qZYCA0ldZOSiqVK+z/2Mec/zuWwEFRXn+RuMi+AqHc8eakdtCd43luEMzNo1H2rXJ9E7RCKhmxiwZhzf5QK9p9ackIVaOFGoBrVozFBISgiR5pWEqoxsu2wMenFjilJ8I6wfxU3TCiM1uFdzXoD5SlWXeyG960kRx3i20lKsMEqiMJLR0USQDdjvI6orwxr/Pl8ennZvUQzVZ3uwXDz8pfPaNZm+z+PVv6EiQV+r9Tb/ax+q59lCz5D/5rN4sf0z71DvPS+mVr1fvOQAmlILRJMnfQbZUxTdcFTppoZVrGaJnOuZm5ZrhlnEfAQZq5AEEbCYS2beEFZo45S4WZcLo1xdzaF6BS0/oFsX+U6/YMTPNSyKmWe7PP9qlvqVXH0K2WHQFHXaNi22hpn2ow0wysn+/w1jvxdlHqzNTEEqwZiKk5HZ7LaPRKE4dcW0dGHoe/S+gCM3XwamEWuH5RD0EzSu3zkCXuhAUhkip12NOGzPvGL5cbrT23kz8HZnf+Rs7+uTj7l+L8BFJPFPJbL/PZIAcXgyxBQwK83aQob74+Jkj8+qOJh5ci/k1RKXBOp3m1++/YDwN9dbGrjZWqQJIWNM4bJiJWxRjyZMCH5wNvpsMP0CF29BuJln8B</diagram></mxfile>

docs/en-US/SUMMARY.md

@@ -0,0 +1,37 @@
+# Summary
+
+[Introduction](index.md)
+
+# Getting started
+
+- [Installation](getting-started/installation.md)
+- [Connecting to a server](getting-started/connecting.md)
+- [Connection parameters](getting-started/connection-parameters.md)
+
+# Using termscp
+
+- [The file explorer](usage/file-explorer.md)
+- [Keyboard shortcuts](usage/keyboard-shortcuts.md)
+- [Working with multiple files](usage/multiple-files.md)
+- [Synchronized browsing](usage/synced-browsing.md)
+- [Opening and editing files](usage/open-edit-files.md)
+- [Bookmarks and recent hosts](usage/bookmarks.md)
+- [Keeping files in sync](usage/file-watcher.md)
+
+# Configuration
+
+- [Configuration](configuration/configuration.md)
+- [File explorer format](configuration/explorer-format.md)
+- [SSH key storage](configuration/ssh-keys.md)
+- [Themes](configuration/themes.md)
+- [Notifications](configuration/notifications.md)
+- [Logging](configuration/logging.md)
+- [Password security](configuration/password-security.md)
+
+# CLI reference
+
+- [Command-line usage](cli/cli.md)
+
+# Developer
+
+- [Developer manual](developer/developer.md)

docs/en-US/book.toml

@@ -0,0 +1,22 @@
+[book]
+title = "termscp"
+description = "A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/Kube/S3/SMB/WebDAV"
+authors = ["Christian Visintin"]
+language = "en"
+src = "."
+
+[output.html]
+default-theme = "light"
+preferred-dark-theme = "navy"
+git-repository-url = "https://github.com/veeso/termscp"
+edit-url-template = "https://github.com/veeso/termscp/edit/main/docs/en-US/{path}"
+additional-js = ["lang-switcher.js", "mermaid.min.js", "mermaid-init.js"]
+
+[output.html.fold]
+enable = true
+level = 1
+
+[preprocessor]
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"

docs/en-US/cli/cli.md

@@ -0,0 +1,76 @@
+# Command-line usage
+
+termscp can be started with the following invocation forms:
+
+```sh
+termscp [options]... [protocol://user@address:port:wrkdir] [protocol://user@address:port:wrkdir] [local-wrkdir]
+```
+
+OR
+
+```sh
+termscp [options]... -b [bookmark-name] -b [bookmark-name] [local-wrkdir]
+```
+
+AND any combination of the two.
+
+If no extra arguments are provided, termscp shows the authentication form. If an
+address argument or a bookmark name is provided, termscp skips the form and
+connects directly to the remote server. When an address or bookmark is given,
+you may also provide the starting working directory for the local host as the
+last positional argument.
+
+## Options
+
+| Key                  | Description                                                                                                                       |
+| -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `-b <bookmark-name>` | Resolve the positional address argument as a bookmark name. Repeat the flag to open multiple bookmarks.                           |
+| `-D`                 | Enable the `TRACE` log level (debug/verbose logging).                                                                             |
+| `-P <password>`      | Provide the password from the CLI. Repeat the flag for multiple remotes; the order must match the address arguments. Discouraged. |
+| `-q`                 | Disable logging.                                                                                                                  |
+| `-T <ticks>`         | Set the UI tick interval in milliseconds. Default is `10`.                                                                        |
+| `--wno-keyring`      | Disable system keyring support.                                                                                                   |
+| `-v`                 | Print version info.                                                                                                               |
+| `--help`             | Print the help page.                                                                                                              |
+
+The `-P` option is discouraged because the password may be kept in the shell
+history. See the bookmarks and password-security chapters for safer ways to
+provide credentials.
+
+## Subcommands
+
+termscp exposes the following subcommands.
+
+### Import a theme
+
+```sh
+termscp theme <theme-file>
+```
+
+Import the theme defined in `<theme-file>`.
+
+### Install the latest version
+
+```sh
+termscp update
+```
+
+Download and install the latest available version of termscp.
+
+### Import ssh hosts
+
+```sh
+termscp import-ssh-hosts [ssh-config-file]
+```
+
+Import all the hosts from the specified ssh config file as bookmarks in
+termscp. If `[ssh-config-file]` is not provided, the default location
+`~/.ssh/config` is used. Identity files are imported as ssh keys in termscp too.
+
+### Open configuration
+
+```sh
+termscp config
+```
+
+Start termscp directly in the configuration (setup) screen.

docs/en-US/configuration/configuration.md

@@ -0,0 +1,50 @@
+# Configuration
+
+termscp supports a number of user-defined parameters. termscp stores them in a
+TOML file and a few directories, but you never edit these files by hand:
+configuration is done entirely from the user interface.
+
+To enter the configuration, press `<CTRL+C>` from the termscp home.
+
+termscp requires these paths to be accessible:
+
+- `$HOME/.config/termscp/` on Linux/BSD
+- `$HOME/.config/termscp/` on macOS
+- `%USERPROFILE%\.termscp\` on Windows
+
+## Parameters
+
+The following parameters can be configured:
+
+- **Text Editor**: the text editor to use. By default termscp finds the default
+  editor for you; with this option you can force an editor to be used (e.g.
+  `vim`). GUI editors are also supported, unless they detach (`nohup`) from the
+  parent process.
+- **Default Protocol**: the default value for the file transfer protocol to be
+  used in termscp. It applies to the login page and to the address CLI argument.
+- **Show Hidden Files**: whether hidden files are displayed by default. You can
+  also toggle hidden files at runtime by pressing `A`.
+- **Check for updates**: if set to `yes`, termscp queries the GitHub API to
+  check whether a new version of termscp is available.
+- **Prompt when replacing existing files**: if set to `yes`, termscp prompts for
+  confirmation whenever a file transfer would replace an existing file on the
+  target host.
+- **Group Dirs**: whether directories are grouped in the file explorers. If
+  `Display first` is selected, directories are sorted with the configured method
+  but displayed before files; with `Display last` they are displayed after
+  files.
+- **Remote file formatter syntax**: syntax used to display file info for each
+  file in the remote explorer. See [File explorer format](explorer-format.md).
+- **Local file formatter syntax**: syntax used to display file info for each file
+  in the local explorer. See [File explorer format](explorer-format.md).
+- **Enable notifications**: if set to `Yes`, desktop notifications are displayed.
+  See [Notifications](notifications.md).
+- **Notifications: minimum transfer size**: if the transfer size is greater than
+  or equal to the specified value, transfer notifications are displayed. The
+  accepted format is `{UNSIGNED} B/KB/MB/GB/TB/PB`.
+- **SSH configuration path**: SSH configuration file to use when connecting to a
+  SCP/SFTP server. If left empty, no file is used. You can specify a path
+  starting with `~` to indicate the home directory (e.g. `~/.ssh/config`). The
+  attributes supported by termscp are listed at
+  [the ssh2-config exposed attributes](https://github.com/veeso/ssh2-config#exposed-attributes).
+  See also [SSH key storage](ssh-keys.md).

docs/en-US/configuration/explorer-format.md

@@ -0,0 +1,49 @@
+# File explorer format
+
+You can define a custom format for the file explorer through the configuration.
+This is possible for both the local and the remote host, so you can use two
+different syntaxes. The fields are named **File formatter syntax (local)** and
+**File formatter syntax (remote)**, and they define how the file entries are
+displayed in the file explorer.
+
+## Syntax
+
+The syntax for the formatter is the following:
+
+```text
+{KEY1}... {KEY2:LENGTH}... {KEY3:LENGTH:EXTRA} {KEYn}...
+```
+
+Each key in braces is replaced with the related attribute, while everything
+outside braces is left unchanged.
+
+- The key name is mandatory and must be one of the keys below.
+- `LENGTH` describes the width reserved to display the field. Static attributes
+  do not support it (`GROUP`, `PEX`, `SIZE`, `USER`).
+- `EXTRA` is supported only by some keys and provides an additional option. See
+  the keys below to check whether `EXTRA` is supported.
+
+## Keys
+
+These are the keys supported by the formatter:
+
+| Key       | Description                                                                                      |
+| --------- | ------------------------------------------------------------------------------------------------ |
+| `ATIME`   | Last access time (default `%b %d %Y %H:%M`); `EXTRA` is the time format (e.g. `{ATIME:8:%H:%M}`) |
+| `CTIME`   | Creation time (default `%b %d %Y %H:%M`); `EXTRA` is the time format (e.g. `{CTIME:8:%H:%M}`)    |
+| `GROUP`   | Owner group                                                                                      |
+| `MTIME`   | Last change time (default `%b %d %Y %H:%M`); `EXTRA` is the time format (e.g. `{MTIME:8:%H:%M}`) |
+| `NAME`    | File name (folders between root and first ancestors are elided if longer than `LENGTH`)          |
+| `PATH`    | File absolute path (folders between root and first ancestors are elided if longer than `LENGTH`) |
+| `PEX`     | File permissions (UNIX format)                                                                   |
+| `SIZE`    | File size (omitted for directories)                                                              |
+| `SYMLINK` | Symlink target (if any, `-> {FILE_PATH}`)                                                        |
+| `USER`    | Owner user                                                                                       |
+
+## Default format
+
+If left empty, the default formatter syntax is used:
+
+```text
+{NAME:24} {PEX} {USER} {SIZE} {MTIME:17:%b %d %Y %H:%M}
+```

docs/en-US/configuration/logging.md

@@ -0,0 +1,28 @@
+# Logging
+
+termscp writes a log file for each session, located at:
+
+- `$HOME/.cache/termscp/termscp.log` on Linux/BSD
+- `$HOME/Library/Caches/termscp/termscp.log` on macOS
+- `FOLDERID_LocalAppData\termscp\termscp.log` on Windows
+
+The log is not rotated: it is truncated on each launch of termscp. If you want
+to report an issue and attach the log file, save the log somewhere safe before
+launching termscp again.
+
+By default the log reports at the `INFO` level, so it is not very verbose.
+
+## Reproducing an issue at TRACE level
+
+To submit an issue, reproduce the problem with the log level set to `TRACE` by
+launching termscp with the `-D` CLI option.
+
+## Disabling logging
+
+To turn logging off, start termscp with the `-q` or `--quiet` option. You can
+alias termscp to make it persistent.
+
+## Security
+
+The log file does not contain any plaintext password. It exposes the same
+information as the sibling `bookmarks` file.

docs/en-US/configuration/notifications.md

@@ -0,0 +1,23 @@
+# Notifications
+
+termscp sends desktop notifications for the following events:
+
+- **Transfer completed**: sent once a transfer has been successfully completed.
+  Displayed only if the total transfer size is at least the configured
+  `Notifications: minimum transfer size`.
+- **Transfer failed**: sent once a transfer has failed due to an error.
+  Displayed only if the total transfer size is at least the configured
+  `Notifications: minimum transfer size`.
+- **Update available**: sent whenever a new version of termscp is available.
+- **Update installed**: sent whenever a new version of termscp has been
+  installed.
+- **Update failed**: sent whenever the installation of an update fails.
+
+## Disable notifications
+
+To turn notifications off, enter setup and set `Enable notifications?` to `No`.
+
+## Change the minimum transfer size
+
+To change the threshold that gates transfer notifications, enter setup and set
+`Notifications: minimum transfer size` to the value that suits you.

docs/en-US/configuration/password-security.md

@@ -0,0 +1,49 @@
+# Password security
+
+Bookmarks are saved in your configuration directory along with their passwords.
+Passwords are not stored in plaintext: they are encrypted with AES.
+
+The key used to encrypt passwords is stored, where possible, in the operating
+system secret store:
+
+- The Windows Vault on Windows
+- The system keyring on Linux
+- The Keychain on macOS
+
+This is managed directly by your operating system.
+
+On BSD and WSL there is no such secret store, so the encryption key is saved on
+disk at `$HOME/.config/termscp`. The location protects the key with file
+permissions so that it cannot be read by other users, but you should still avoid
+saving passwords for servers exposed on the internet on these systems.
+
+## Linux keyring
+
+On Linux there might be no keyring installed on your system. The key storage
+requires a service that exposes `org.freedesktop.secrets` on D-Bus, and only a
+few services provide it:
+
+- If you use GNOME as your desktop environment (e.g. Ubuntu users), the keyring
+  is already provided by `gnome-keyring` and everything should work out of the
+  box.
+- For other desktop environments, you can use [KeepassXC](https://keepassxc.org/)
+  to obtain a keyring. It must be set up to work with termscp; see
+  [KeepassXC setup](#keepassxc-setup) below.
+- If you do not want to install any of these services, termscp keeps working as
+  usual and falls back to saving the key in a file, as it does for BSD and WSL.
+
+### KeepassXC setup
+
+Follow these steps to set up KeepassXC for termscp:
+
+1. Install KeepassXC.
+2. Go to "Tools" > "Settings" in the toolbar.
+3. Select "Secret service integration" and enable "Enable KeepassXC
+   freedesktop.org secret service integration".
+4. Create a database, if you do not have one yet: from the toolbar, "Database" >
+   "New database".
+5. From the toolbar, go to "Database" > "Database settings".
+6. Select "Secret service integration" and enable "Expose entries under this
+   group".
+7. Select the group where the termscp secret will be kept. Note that any other
+   application can read secrets exposed via D-Bus for that group.

docs/en-US/configuration/ssh-keys.md

@@ -0,0 +1,25 @@
+# SSH key storage
+
+Along with configuration, termscp provides an essential feature for SFTP/SCP
+clients: the SSH key storage.
+
+To access the SSH key storage, enter the configuration and move to the
+`SSH Keys` tab.
+
+## Manage keys
+
+From the `SSH Keys` tab you can:
+
+- **Add a new key**: press `<CTRL+N>`. You are prompted to provide the
+  hostname/IP address and the username associated with the key, then a text
+  editor opens: paste the **private** SSH key into the editor, save and quit.
+- **Remove an existing key**: press `<DEL>` or `<CTRL+E>` on the key you want to
+  remove to delete it persistently from termscp.
+- **Edit an existing key**: press `<ENTER>` on the key you want to edit to change
+  the private key.
+
+## Password-protected keys
+
+Password-protected private keys are supported. The password you provide for
+authentication in termscp is valid both for username/password authentication and
+for key authentication.

docs/en-US/configuration/themes.md

@@ -0,0 +1,113 @@
+# Themes
+
+termscp lets you set the colors for several components in the application. There
+are two ways to customize termscp:
+
+- From the **configuration menu**
+- Importing a **theme file**
+
+## Customize from the configuration menu
+
+To customize termscp from the configuration menu, enter the configuration from
+the auth screen by pressing `<CTRL+C>`, then press `<TAB>` twice to reach the
+`themes` panel. Move with `<UP>` and `<DOWN>` to select the style you want to
+change, as shown in the gif below:
+
+![Themes](https://github.com/veeso/termscp/blob/main/assets/images/themes.gif?raw=true)
+
+## Import a theme file
+
+You can also import theme files. You can take inspiration from, or directly use,
+one of the themes bundled with termscp in the `themes/` directory of the
+repository. Import a theme by running:
+
+```sh
+termscp theme <theme_file>
+```
+
+If everything is fine, termscp confirms the theme has been imported.
+
+## Color syntax
+
+termscp accepts the following color formats:
+
+- Explicit hexadecimal: `#rrggbb`
+- RGB: `rgb(r, g, b)`
+- [CSS color names](https://www.w3schools.com/cssref/css_colors.asp) (such as
+  `crimson`)
+- The special keyword `Default`, which uses the situational default foreground
+  or background color (foreground for texts and lines, background otherwise)
+
+## Recovering from a theme that won't load
+
+After an update, a saved theme can fail to load. This happens when a new key is
+added to themes: the previously saved theme no longer contains that key. There
+are two quick fixes:
+
+1. Re-import the official theme. After each release the official themes are
+   patched, so download the updated theme from the repository and re-import it:
+
+    ```sh
+    termscp theme <theme.toml>
+    ```
+
+2. Edit your theme by hand. If you use a custom theme, edit the file and add the
+   missing key. The theme is located at `$CONFIG_DIR/theme.toml`, where
+   `$CONFIG_DIR` is:
+
+    - FreeBSD/Linux: `$HOME/.config/termscp`
+    - macOS: `$HOME/.config/termscp`
+    - Windows: `%USERPROFILE%\.termscp`
+
+    Missing keys are reported in the CHANGELOG under `BREAKING CHANGES` for the
+    version you have just installed.
+
+## Styles
+
+The tables below describe each style field. Note that styles do **not** apply to
+the configuration page, so it always remains usable in case you change something
+by mistake.
+
+### Authentication page
+
+| Key              | Description                              |
+| ---------------- | ---------------------------------------- |
+| `auth_address`   | Color of the input field for IP address  |
+| `auth_bookmarks` | Color of the bookmarks panel             |
+| `auth_password`  | Color of the input field for password    |
+| `auth_port`      | Color of the input field for port number |
+| `auth_protocol`  | Color of the radio group for protocol    |
+| `auth_recents`   | Color of the recents panel               |
+| `auth_username`  | Color of the input field for username    |
+
+### Transfer page
+
+| Key                                    | Description                                                               |
+| -------------------------------------- | ------------------------------------------------------------------------- |
+| `transfer_local_explorer_background`   | Background color of localhost explorer                                    |
+| `transfer_local_explorer_foreground`   | Foreground color of localhost explorer                                    |
+| `transfer_local_explorer_highlighted`  | Border and highlighted color for localhost explorer                       |
+| `transfer_remote_explorer_background`  | Background color of remote explorer                                       |
+| `transfer_remote_explorer_foreground`  | Foreground color of remote explorer                                       |
+| `transfer_remote_explorer_highlighted` | Border and highlighted color for remote explorer                          |
+| `transfer_log_background`              | Background color for log panel                                            |
+| `transfer_log_window`                  | Window color for log panel                                                |
+| `transfer_progress_bar_partial`        | Partial progress bar color                                                |
+| `transfer_progress_bar_total`          | Total progress bar color                                                  |
+| `transfer_status_hidden`               | Color for status bar "hidden" label                                       |
+| `transfer_status_sorting`              | Color for status bar "sorting" label; applies also to file sorting dialog |
+| `transfer_status_sync_browsing`        | Color for status bar "sync browsing" label                                |
+
+### Misc
+
+These styles apply to different parts of the application.
+
+| Key                 | Description                                 |
+| ------------------- | ------------------------------------------- |
+| `misc_error_dialog` | Color for error messages                    |
+| `misc_info_dialog`  | Color for info dialogs                      |
+| `misc_input_dialog` | Color for input dialogs (such as copy file) |
+| `misc_keys`         | Color of text for key strokes               |
+| `misc_quit_dialog`  | Color for quit dialogs                      |
+| `misc_save_dialog`  | Color for save dialogs                      |
+| `misc_warn_dialog`  | Color for warn dialogs                      |

docs/en-US/developer/developer.md

@@ -0,0 +1,128 @@
+# Developer manual
+
+Welcome to the developer manual for termscp. This chapter does NOT contain the
+documentation for termscp modules, which can instead be found on Rust Docs at
+<https://docs.rs/termscp>. This chapter describes how termscp works and the
+guidelines to implement features such as file transfers and additions to the
+user interface.
+
+termscp is written in Rust (edition 2024, MSRV 1.89.0). The user interface is
+built with [tuirealm](https://github.com/veeso/tui-realm) v3, which runs on top
+of [crossterm](https://github.com/crossterm-rs/crossterm).
+
+## How termscp works
+
+termscp is basically made up of 3 core modules:
+
+- The **host**: the host module provides functions to interact with file
+  systems. It exposes the `HostBridge` trait, which abstracts file operations
+  over both the local host (`Localhost`) and the remote host (`RemoteBridged`).
+- The **ui**: this module contains the implementation of the user interface. As
+  shown in the next chapter, this is achieved through **activities**.
+- The **activity_manager**: the activity manager takes care of managing
+  activities. It runs the activities of the user interface and chooses, based on
+  their state, when to terminate the current activity and which activity to run
+  next.
+
+In addition to the 3 core modules, others have been added over time:
+
+- **config**: provides the configuration schema and its serialization methods.
+- **explorer**: exposes the explorer structures, which are used to handle the
+  file explorer in the ui. They store the current directory model and the view
+  states (e.g. sorting, whether to display hidden files, the transfer queue).
+- **filetransfer**: defines the `FileTransferProtocol` enum and the
+  `RemoteFsBuilder`, which constructs the appropriate `RemoteFs` client from the
+  connection parameters.
+- **system**: provides a way to interact with the configuration, the ssh key
+  storage and the bookmarks.
+- **utils**: contains the utilities used by pretty much all of the project.
+
+termscp supports the following protocols: SFTP, SCP, FTP/FTPS, Kube, S3, SMB and
+WebDAV.
+
+## Activities
+
+This paragraph gives a short overview of activities. Read the code and the
+documentation for a clear idea of how the ui works.
+
+There are many ways to implement a user interface. This project borrows what
+works best from different frameworks:
+
+- **Activities on top**: each "view" is an Activity, and an `Activity Manager`
+  handles them. This approach is inspired by Android. It fits a ui that has
+  different views, each one with its own components and logic. Activities work
+  with the `Context`, which is a data holder used to share data between
+  activities.
+- **Activities display Applications**: each activity can show different
+  **Applications**. An application contains a **View**, which is basically a list
+  of **components**, each one with its properties. The view is a facade to the
+  components and also handles the focus, which is the current active component.
+  You cannot have more than one active component, so this must be handled; at the
+  same time, focus must be given back to the previously active component if the
+  current one is destroyed. The **Application** takes care of all this. To learn
+  more, read <https://github.com/veeso/tui-realm>.
+- **Components**: components are built around tui in order to reuse widgets. This
+  is achieved through the `Component` trait, inspired by
+  [React](https://reactjs.org/). Each component has its *Properties* and can have
+  its *States*. Each component must handle input events, accept new properties,
+  and provide a method to **render** itself. This logic now lives in
+  [tui-realm](https://github.com/veeso/tui-realm).
+- **Messages: an Elm-based approach**: input events are handled with an approach
+  inspired by [Elm](https://elm-lang.org/). In Elm you implement your ui using
+  three basic functions: **update**, **view** and **init**. termscp implements
+  the equivalent of the Elm update function as a large match case inside a
+  recursive function, which you can find in the `update.rs` file inside each
+  activity. This match case handles the messages produced by the components in
+  response to incoming input events and causes the activity to change its state.
+
+termscp implements a trait called `Activity`, a much reduced version of the
+Android activity. This trait provides these methods:
+
+- `on_create`: initializes the activity. The context is passed to the activity,
+  which becomes the only owner of the Context until the activity terminates.
+- `on_draw`: called each time the user interface should be updated. This is
+  basically the run method of the activity, and it also handles input events. The
+  interface should not be drawn on every call (this method may be called hundreds
+  of times per second), but only when something has actually changed (for example
+  after an input event).
+- `will_umount`: returns whether the activity should be destroyed. If so, it
+  returns an `ExitReason`, which indicates why the activity should terminate.
+  Based on the reason, the activity manager chooses whether to stop the execution
+  of termscp or to start a new activity, and which one.
+- `on_destroy`: finalizes the activity and drops it. This method returns the
+  Context to the caller (the activity manager).
+
+### The Context
+
+The context is a structure that holds data shared between activities. Every time
+an Activity starts, the Context is taken by the activity, until it is destroyed,
+where the context is finally returned to the activity manager. The context holds
+the following data:
+
+- The **Localhost**: the local host structure.
+- The **File Transfer Params**: the current parameters used to connect to the
+  remote.
+- The **Config Client**: a structure that provides functions to access the user
+  configuration.
+- The **Store**: a key-value storage that can hold any kind of data. It can be
+  used to share state between activities or to keep persistence for heavy or slow
+  tasks (such as checking for updates).
+- The **Terminal**: used to render the tui on the terminal.
+
+## Achieving an abstract file transfer client
+
+When the implementation of termscp started, in December 2020, file transfer was
+at the core of the design, since it is at the heart of termscp. The first
+implementation consisted of a `filetransfer` module that exposed a trait called
+`FileTransfer`, which provided methods to generically interact with the remote
+file system.
+
+This changed over time, as different users asked for a dedicated library. In the
+last quarter of 2021, [remotefs](https://github.com/veeso/remotefs-rs) was born:
+an abstract library to work with remote device file systems. remotefs provides a
+`RemoteFs` trait that exposes all of the core file-system functionalities, and
+since version 0.8.0 it has replaced the `FileTransfer` trait.
+
+The file transfer module still exists, but its only task is to build a
+`RemoteFs` client implementation from the file transfer parameters through the
+`RemoteFsBuilder`.

docs/en-US/getting-started/connecting.md

@@ -0,0 +1,77 @@
+# Connecting to a server
+
+termscp can start in three different ways depending on the arguments you pass.
+
+- No arguments: termscp opens the authentication form, where you provide the
+  parameters required to connect to the remote host.
+- An address argument: termscp skips the authentication form and connects
+  directly to the remote host.
+- A bookmark name with `-b <bookmark-name>`: termscp resolves the argument as a
+  saved bookmark and connects. Repeat `-b` to open several bookmarks.
+
+When you provide an address argument or a bookmark name, you can also provide a
+start working directory for the local host.
+
+## The authentication form
+
+When termscp starts without an address, it shows the authentication form. Fill
+in the protocol, address, port, username, and password, then connect. termscp
+will open the dual-pane explorer once the connection succeeds.
+
+## Address argument syntax
+
+The generic address argument has the following syntax:
+
+```txt
+[protocol://][username@]<address>[:port][:wrkdir]
+```
+
+This syntax is convenient, and you will probably use it instead of the
+interactive form. Here are some examples.
+
+Connect using the default protocol (defined in your configuration) to
+`192.168.1.31`. If the port is not provided, the default port for the selected
+protocol is used. The username is the current user's name.
+
+```sh
+termscp 192.168.1.31
+```
+
+Connect using the default protocol to `192.168.1.31` as user `root`:
+
+```sh
+termscp root@192.168.1.31
+```
+
+Connect using SCP to `192.168.1.31` on port `4022` as user `omar`:
+
+```sh
+termscp scp://omar@192.168.1.31:4022
+```
+
+Connect using SCP to `192.168.1.31` on port `4022` as user `omar`, starting in
+directory `/tmp`:
+
+```sh
+termscp scp://omar@192.168.1.31:4022:/tmp
+```
+
+For protocol-specific address syntax (S3, Kube, WebDAV, and SMB), see
+[Connection parameters](connection-parameters.md).
+
+## How the password is provided
+
+When you provide the address as an argument, there is no field for the password
+in the address itself. You can provide the password in three ways:
+
+- You will be prompted for it. This is the default: if you don't use any of the
+  methods below, termscp prompts for the password, like classic tools such as
+  `scp` and `ssh`.
+- `-P, --password` option: pass the password directly on the command line. This
+  method is discouraged because it is insecure: the password may be kept in
+  your shell history.
+- Via `sshpass`: provide the password through `sshpass`, for example:
+
+  ```sh
+  sshpass -f ~/.ssh/topsecret.key termscp cvisintin@192.168.1.31
+  ```

docs/en-US/getting-started/connection-parameters.md

@@ -0,0 +1,168 @@
+# Connection parameters
+
+Each protocol has its own set of authentication-form fields and its own
+command-line address syntax. This page describes them protocol by protocol.
+
+## SFTP / SCP
+
+Authentication-form fields:
+
+- Host (address)
+- Port (default `22`)
+- Username
+- Password or SSH key
+
+You can authenticate either with a username and password or with an SSH key.
+See [SSH key storage](../configuration/ssh-keys.md) for how to manage keys.
+
+Address syntax:
+
+```txt
+[protocol://][username@]<address>[:port][:wrkdir]
+```
+
+## FTP / FTPS
+
+Authentication-form fields:
+
+- Host (address)
+- Port (default `21`)
+- Username
+- Password
+- Secure (FTPS): enable TLS to use FTPS instead of plain FTP
+
+Address syntax:
+
+```txt
+[protocol://][username@]<address>[:port][:wrkdir]
+```
+
+## Kube
+
+Authentication-form fields:
+
+- Namespace
+- Cluster URL (Kubernetes API URL)
+- Username
+- Client certificate path
+- Client key path
+
+Address syntax:
+
+```txt
+kube://[namespace][@<cluster_url>][$</path>]
+```
+
+## S3
+
+termscp supports both AWS S3 and other S3-compatible endpoints.
+
+Authentication-form fields:
+
+- Bucket name
+- Region (for AWS S3) or endpoint (for other S3-compatible servers)
+- Profile
+- Access key
+- Secret access key
+- Security token
+- Session token
+- New path style
+
+The required and optional fields differ depending on the endpoint:
+
+- AWS S3:
+  - bucket name (required)
+  - region (required)
+  - profile (optional; defaults to `default`)
+  - access key (required unless the bucket is public)
+  - secret access key (required unless the bucket is public)
+  - security token (if required)
+  - session token (if required)
+  - new path style: NO
+- Other S3 endpoints:
+  - bucket name (required)
+  - endpoint (required)
+  - access key (required unless the bucket is public)
+  - secret access key (required unless the bucket is public)
+  - new path style: YES
+
+Address syntax:
+
+```txt
+s3://<bucket>@<region>[:profile][:/wrkdir]
+```
+
+For example:
+
+```txt
+s3://buckethead@eu-central-1:default:/assets
+```
+
+### S3 credentials
+
+To connect to an AWS S3 bucket you must provide credentials. There are three
+ways to do this.
+
+1. Authentication form: provide the access key (usually mandatory), the secret
+   access key (usually mandatory), the security token, and the session token.
+   If you save the S3 connection as a bookmark, the access key and secret access
+   key are saved as an encrypted AES-256/BASE64 string in your bookmarks file.
+   The security token and session token are not saved, since they are meant to
+   be temporary credentials.
+2. Credentials file: configure the AWS CLI with `aws configure`. Your
+   credentials are then stored at `~/.aws/credentials`. If you use a profile
+   other than `default`, provide it in the profile field of the authentication
+   form.
+3. Environment variables: provide your credentials as environment variables.
+   These always override the credentials in the credentials file. The following
+   are usually mandatory:
+
+   - `AWS_ACCESS_KEY_ID`: AWS access key ID (usually starts with `AKIA...`)
+   - `AWS_SECRET_ACCESS_KEY`: the secret access key
+
+   If you have configured stronger security, you may also need:
+
+   - `AWS_SECURITY_TOKEN`: security token
+   - `AWS_SESSION_TOKEN`: session token
+
+Your credentials are safe: termscp does not manipulate these values directly.
+They are consumed directly by the `s3` crate.
+
+## SMB
+
+Authentication-form fields:
+
+- Server (address)
+- Share
+- Username
+- Password
+- Port (other systems only; default `445`)
+- Workgroup (other systems only)
+
+On Windows the port and workgroup fields are not used.
+
+Windows address syntax:
+
+```txt
+\\[username@]<server-name>\<share>[\path\...]
+```
+
+Other systems address syntax:
+
+```txt
+smb://[username@]<server-name>[:port]/<share>[/path/.../]
+```
+
+## WebDAV
+
+Authentication-form fields:
+
+- URI (the base WebDAV endpoint)
+- Username
+- Password
+
+Address syntax:
+
+```txt
+http(s)://<username>:<password>@<url></path>
+```

docs/en-US/getting-started/installation.md

@@ -0,0 +1,83 @@
+# Installation
+
+termscp is available for many platforms. Pick the method that matches your
+system below.
+
+## Linux, FreeBSD, and macOS
+
+This shell script installs termscp on your system with a single command:
+
+```sh
+curl --proto '=https' --tlsv1.2 -sSLf https://termscp.rs/install.sh | sh
+```
+
+On macOS the installation requires [Homebrew](https://brew.sh/); otherwise the
+Rust compiler is installed to build termscp from source.
+
+## Windows
+
+Install termscp from PowerShell with a single command:
+
+```ps
+irm https://termscp.rs/install.ps1 | iex
+```
+
+Alternatively, install it with [Chocolatey](https://chocolatey.org/):
+
+```ps
+choco install termscp
+```
+
+## NetBSD
+
+Install termscp from the official repositories:
+
+```sh
+pkgin install termscp
+```
+
+## Arch Linux
+
+Install termscp from the official repositories:
+
+```sh
+pacman -S termscp
+```
+
+## Requirements
+
+The following system dependencies are required to run termscp.
+
+- Linux users:
+  - libdbus-1
+  - pkg-config
+  - libsmbclient
+- FreeBSD and NetBSD users:
+  - dbus
+  - pkgconf
+  - libsmbclient
+
+### Optional requirements
+
+These dependencies are not required to run termscp, but they are needed to
+enjoy all of its features.
+
+- Linux and FreeBSD users, to open files via `V` (at least one of these):
+  - xdg-open
+  - gio
+  - gnome-open
+  - kde-open
+- Linux users: a keyring manager. Read more in the
+  [Password security](../configuration/password-security.md) page.
+- WSL users, to open files via `V`:
+  - [wslu](https://github.com/wslutilities/wslu)
+
+## Updating termscp
+
+To update termscp to the latest version, run it from the command line with:
+
+```sh
+(sudo) termscp update
+```
+
+For all platforms and methods, see <https://termscp.rs/install>.

docs/en-US/index.md

@@ -0,0 +1,28 @@
+# termscp
+
+![termscp explorer](https://github.com/veeso/termscp/blob/main/assets/images/explorer.gif?raw=true)
+
+termscp is a feature-rich terminal file transfer client and explorer with a
+TUI (Terminal User Interface). It lets you connect to a remote server to
+upload and download files while interacting with your local file system at the
+same time. termscp runs on Linux, macOS, FreeBSD, NetBSD, and Windows.
+
+## Features
+
+- Multiple transfer protocols: SFTP, SCP, FTP and FTPS, Kube, S3, SMB,
+  and WebDAV.
+- Dual-pane explorer to browse and operate on both the remote and the local
+  file system: create, remove, rename, search, view, and edit files.
+- Bookmarks and recent connections to quickly reconnect to your favorite
+  hosts.
+- View and edit files with your favorite editor.
+- SFTP/SCP authentication with SSH keys or username and password.
+- Embedded terminal for running commands on your system.
+- Make it yours: themes, custom file explorer format, customizable text
+  editor, and customizable file sorting.
+- Desktop notifications when a large file has been transferred.
+- File watcher that keeps your changes synchronized with the remote host.
+- Save your passwords in your operating system's key vault.
+- Rust-powered and built with an eye on performance.
+
+Ready to try it? See [Installation](getting-started/installation.md).

docs/en-US/lang-switcher.js

@@ -0,0 +1,47 @@
+// Injects a language toggle (EN / 中文) into the mdBook menu bar.
+// Swaps the leading /en-US/ <-> /zh-CN/ path segment, preserving the
+// rest of the path; falls back to the language root on 404 navigation.
+(function () {
+  const LANGS = [
+    { code: "en-US", label: "EN" },
+    { code: "zh-CN", label: "中文" },
+  ];
+
+  function currentLang() {
+    const m = window.location.pathname.match(/\/(en-US|zh-CN)\//);
+    return m ? m[1] : "en-US";
+  }
+
+  function swapTo(code) {
+    const path = window.location.pathname;
+    const cur = currentLang();
+    if (path.includes(`/${cur}/`)) {
+      return path.replace(`/${cur}/`, `/${code}/`);
+    }
+    return `/${code}/`;
+  }
+
+  function build() {
+    const right = document.querySelector(".right-buttons");
+    if (!right) return;
+    const cur = currentLang();
+    const wrap = document.createElement("div");
+    wrap.className = "lang-switcher";
+    wrap.style.display = "inline-flex";
+    wrap.style.gap = "0.5rem";
+    wrap.style.marginInlineStart = "0.5rem";
+    LANGS.forEach((l) => {
+      const a = document.createElement("a");
+      a.textContent = l.label;
+      a.href = swapTo(l.code);
+      a.title = l.code;
+      a.setAttribute("aria-current", l.code === cur ? "true" : "false");
+      if (l.code === cur) a.style.fontWeight = "bold";
+      wrap.appendChild(a);
+    });
+    right.appendChild(wrap);
+  }
+
+  if (document.readyState !== "loading") build();
+  else document.addEventListener("DOMContentLoaded", build);
+})();

docs/en-US/mermaid-init.js

@@ -0,0 +1,39 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+(() => {
+    const darkThemes = ['ayu', 'navy', 'coal'];
+    const lightThemes = ['light', 'rust'];
+
+    const classList = document.getElementsByTagName('html')[0].classList;
+
+    let lastThemeWasLight = true;
+    for (const cssClass of classList) {
+        if (darkThemes.includes(cssClass)) {
+            lastThemeWasLight = false;
+            break;
+        }
+    }
+
+    const theme = lastThemeWasLight ? 'default' : 'dark';
+    mermaid.initialize({ startOnLoad: true, theme });
+
+    // Simplest way to make mermaid re-render the diagrams in the new theme is via refreshing the page
+
+    for (const darkTheme of darkThemes) {
+        document.getElementById(darkTheme).addEventListener('click', () => {
+            if (lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+
+    for (const lightTheme of lightThemes) {
+        document.getElementById(lightTheme).addEventListener('click', () => {
+            if (!lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+})();

docs/en-US/theme/head.hbs

@@ -0,0 +1,13 @@
+<link rel="icon" type="image/x-icon" href="/shared/favicon.ico">
+<link rel="icon" type="image/svg+xml" href="/shared/termscp.svg">
+
+<meta property="og:title" content="{{#if chapter_title}}{{ chapter_title }} · {{/if}}{{ book_title }}">
+<meta property="og:description" content="A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/Kube/S3/SMB/WebDAV">
+<meta property="og:image" content="https://docs.termscp.rs/og_preview.jpg">
+<meta property="og:url" content="https://docs.termscp.rs/">
+<meta property="og:type" content="website">
+
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:title" content="{{#if chapter_title}}{{ chapter_title }} · {{/if}}{{ book_title }}">
+<meta name="twitter:description" content="A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/Kube/S3/SMB/WebDAV">
+<meta name="twitter:image" content="https://docs.termscp.rs/og_preview.jpg">

docs/en-US/usage/bookmarks.md

@@ -0,0 +1,31 @@
+# Bookmarks and recent hosts
+
+termscp lets you save your favourite hosts as bookmarks, which can then be loaded quickly from the main layout. termscp also keeps the last 16 hosts you connected to. Both features let you reload all the parameters required to connect to a remote simply by selecting an entry in the tab under the authentication form.
+
+## Where bookmarks are stored
+
+Bookmarks are saved, when possible, in the configuration directory:
+
+- `$HOME/.config/termscp/` on Linux/BSD
+- `$HOME/.config/termscp/` on macOS
+- `%USERPROFILE%\.termscp\` on Windows
+
+## Saving passwords
+
+For bookmarks only, you can optionally save the password used to authenticate. This does not apply to recent hosts, which never save passwords. The password is not saved by default; you are prompted to choose whether to save it when you create a new bookmark.
+
+If you are concerned about the security of the passwords saved for your bookmarks, see [Are my passwords safe?](../configuration/password-security.md)
+
+## Creating a bookmark
+
+1. Fill in the authentication form with the parameters to connect to your remote server.
+2. Press `<CTRL+S>`.
+3. Type the name you want to give to the bookmark.
+4. Choose whether to remember the password.
+5. Press `<ENTER>` to submit.
+
+## Loading a bookmark
+
+To use a previously saved connection, press `<TAB>` to navigate to the bookmarks list, then press `<ENTER>` to load the bookmark parameters into the form.
+
+![Bookmarks](https://github.com/veeso/termscp/blob/main/assets/images/bookmarks.gif?raw=true)

docs/en-US/usage/file-explorer.md

@@ -0,0 +1,18 @@
+# The file explorer
+
+After you establish a connection with a remote host, termscp shows the file explorer. The explorer is made up of three panels.
+
+- **Local explorer panel**: displayed on the left of the screen. It shows the entries of the current directory on localhost.
+- **Remote explorer panel**: displayed on the right of the screen. It shows the entries of the current directory on the remote host.
+- **Find results panel**: shown after you search for files. Depending on where you searched (local or remote), it replaces the local explorer panel or the remote explorer panel and lists the entries matching your search query.
+
+## Switching between panels
+
+Use the following keys to move between panels.
+
+- `<LEFT>`: move to the local explorer panel.
+- `<RIGHT>`: move to the remote explorer panel.
+- `<TAB>`: switch the active explorer tab.
+- `<ESC>`: while in the find results panel, exit it and return to the previous panel.
+
+For the complete list of keys available in the explorer, see [Keyboard shortcuts](keyboard-shortcuts.md).

docs/en-US/usage/file-watcher.md

@@ -0,0 +1,29 @@
+# Keeping files in sync
+
+The file watcher synchronizes local paths to a remote path. When a change is detected on a watched local path, it is propagated to the configured remote path within about 5 seconds.
+
+You can watch as many paths as you like.
+
+## Watching a path
+
+1. Put the cursor on the local explorer, on the file or directory you want to keep synchronized.
+2. In the remote panel, navigate to the directory where the changes should be reported.
+3. Press `<T>`.
+4. Answer `<YES>` to the popup.
+
+## Unwatching a path
+
+You can stop watching a path in two ways:
+
+- Press `<T>` on the watched local path (or any of its subfolders).
+- Press `<CTRL+T>`, then press `<ENTER>` on the path you want to unwatch.
+
+## Propagated changes
+
+The following changes are reported to the remote host:
+
+- New files and file changes
+- Files moved or renamed
+- Files removed or unlinked
+
+The watcher works in one direction only (local to remote). Changes made on the remote host are **not** synchronized back to the local host.

docs/en-US/usage/keyboard-shortcuts.md

@@ -0,0 +1,49 @@
+# Keyboard shortcuts
+
+The following keys are available in the file explorer. Press `<H|F1>` at any time to open the in-app help.
+
+| Key            | Action                                                                 |
+| -------------- | ---------------------------------------------------------------------- |
+| `<ESC>`        | Disconnect from the remote and return to the authentication page       |
+| `<BACKSPACE>`  | Go to the previous directory in the navigation stack                   |
+| `<TAB>`        | Switch the active explorer tab                                         |
+| `<RIGHT>`      | Move to the remote explorer tab                                        |
+| `<LEFT>`       | Move to the local explorer tab                                         |
+| `<UP>`         | Move up in the selected list                                           |
+| `<DOWN>`       | Move down in the selected list                                         |
+| `<PGUP>`       | Move up in the selected list by 8 rows                                 |
+| `<PGDOWN>`     | Move down in the selected list by 8 rows                               |
+| `<ENTER>`      | Enter the selected directory                                           |
+| `<SPACE>`      | Upload or download the selected file                                   |
+| `<BACKTAB>`    | Switch between the log tab and the explorer                            |
+| `<A>`          | Toggle the display of hidden files                                     |
+| `<B>`          | Choose how files are sorted                                            |
+| `<C\|F5>`      | Copy the selected file or directory                                    |
+| `<D\|F7>`      | Make a new directory                                                   |
+| `<E\|F8\|DEL>` | Delete the selected file                                               |
+| `<F>`          | Search for files (wildcard matching is supported)                      |
+| `<G>`          | Go to the supplied path                                                |
+| `<H\|F1>`      | Show the help                                                          |
+| `<I>`          | Show information about the selected file or directory                  |
+| `<K>`          | Create a symlink pointing to the currently selected entry              |
+| `<L>`          | Reload the current directory's content, or clear the current selection |
+| `<M>`          | Select a file                                                          |
+| `<N>`          | Create a new file with the provided name                               |
+| `<O\|F4>`      | Edit the selected file in your text editor                             |
+| `<P>`          | Open the log panel                                                     |
+| `<Q\|F10>`     | Quit termscp                                                           |
+| `<R\|F6>`      | Rename the selected file                                               |
+| `<S\|F2>`      | Save the selected file as a new name                                   |
+| `<T>`          | Synchronize changes on the selected path to the remote                 |
+| `<U>`          | Go to the parent directory                                             |
+| `<V\|F3>`      | Open the selected file with the default program for its file type      |
+| `<W>`          | Open the selected file with a program you specify                      |
+| `<X>`          | Execute a command                                                      |
+| `<Y>`          | Toggle synchronized browsing                                           |
+| `<Z>`          | Change the file mode                                                   |
+| `</>`          | Filter files (both regex and wildcard matching are supported)          |
+| `<CTRL+A>`     | Select all files                                                       |
+| `<ALT+A>`      | Deselect all files                                                     |
+| `<CTRL+C>`     | Abort the file transfer process                                        |
+| `<CTRL+S>`     | Get the total size of the selected path                                |
+| `<CTRL+T>`     | Show all synchronized paths                                            |

docs/en-US/usage/multiple-files.md

@@ -0,0 +1,32 @@
+# Working with multiple files
+
+termscp lets you act on several files at once. Use these controls to build a selection.
+
+- `<M>`: mark the highlighted file for selection.
+- `<CTRL+A>`: select all files in the current directory.
+- `<ALT+A>`: deselect all files.
+
+Once a file is marked for selection, it is displayed with a highlighted background.
+
+When a selection exists, only the selected files are processed for actions; the currently highlighted item is ignored. You can also work on multiple files while in the find results panel.
+
+## Actions on a selection
+
+All actions are available when working with multiple files, but some behave slightly differently. With a selection, the name you enter refers to the destination directory rather than a single destination file.
+
+- **Copy**: you are prompted for a destination. With multiple files selected, this name is the destination directory where all the files are copied.
+- **Rename**: same as copy, but the files are moved to the destination directory.
+- **Save as**: same as copy, but the files are written to the destination directory.
+
+## The transfer queue
+
+If you select a file in a directory (for example `/home`) and then change directory, the file stays selected and is shown in the **transfer queue** in the bottom panel.
+
+When a file is selected, the remote directory active at that moment is associated with its entry. If the file is later transferred, it is transferred to the remote directory associated with it.
+
+### Example
+
+Suppose you select the local file `/home/a.txt` while the remote panel is at `/tmp`, then you move to `/var`, select `/var/b.txt` while the remote panel is at `/home`, and finally perform a transfer. The result is:
+
+- `/home/a.txt` is transferred to `/tmp/a.txt`
+- `/var/b.txt` is transferred to `/home/b.txt`

docs/en-US/usage/open-edit-files.md

@@ -0,0 +1,24 @@
+# Opening and editing files
+
+termscp can open files with an external application and edit text files in your configured editor. Both local and remote files are supported.
+
+## Open and Open With
+
+Press `<V>` to open a file with the system default application for its file type. termscp relies on your operating system's default opener (powered by the [open](https://docs.rs/crate/open/1.7.0) crate), so make sure at least one of the following is available on your system.
+
+- **Windows**: handled automatically through the `start` command.
+- **macOS**: handled automatically through `open`, which is already installed.
+- **Linux**: one of `xdg-open`, `gio`, `gnome-open`, or `kde-open` must be installed.
+- **WSL**: `wslview` is required. Install [wslu](https://github.com/wslutilities/wslu).
+
+Press `<W>` to open a file with a program you specify.
+
+## Editing text files
+
+Press `<O>` to open a file in your configured text editor. Only text files are supported; binary files are not.
+
+If the file is located on the remote host, it is first downloaded into your temporary file directory, and then re-uploaded to the remote host **only** if you changed it. termscp detects changes by checking the file's last modification time.
+
+## Editing remote files
+
+You cannot edit a remote file in place directly from the remote panel. When you open a remote file, it is downloaded into a temporary directory, but termscp cannot create a watcher to detect when the external program you used to open it has closed, so it cannot tell when you are done editing. To edit a remote file, download it to a local directory first, edit it there, and then upload it again.

docs/en-US/usage/synced-browsing.md

@@ -0,0 +1,5 @@
+# Synchronized browsing
+
+Synchronized browsing keeps navigation in sync between the two explorer panels. While it is enabled, whenever you change the working directory in one panel, the same change is reproduced in the other panel.
+
+To enable synchronized browsing, press `<Y>`. Press `<Y>` again to disable it. While it is enabled, the status bar reports the synchronized browsing state as `ON`.

docs/misc/README.deb.txt

@@ -0,0 +1,28 @@
+Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/Kube/S3/WebDAV. 
+Basically is a terminal utility with an TUI to connect to a remote server to retrieve and upload files and
+to interact with the local file system.
+
+Features:
+
+- 📁  Different communication protocols
+  - SFTP
+  - SCP
+  - FTP and FTPS
+  - S3
+- 🖥  Explore and operate on the remote and on the local machine file system with a handy UI
+  - Create, remove, rename, search, view and edit files
+- ⭐  Connect to your favourite hosts through built-in bookmarks and recent connections
+- 📝  View and edit files with your favourite applications
+- 💁  SFTP/SCP authentication with SSH keys and username/password
+- 🐧  Compatible with Windows, Linux, FreeBSD and MacOS
+- 🎨  Make it yours!
+  - Themes
+  - Custom file explorer format
+  - Customizable text editor
+  - Customizable file sorting
+  - and many other parameters...
+- 📫  Get notified via Desktop Notifications when a large file has been transferred
+- 🔐  Save your password in your operating system key vault
+- 🦀  Rust-powered
+- 👀  Developed keeping an eye on performance
+- 🦄  Frequent awesome updates

docs/shared/lang-switcher.js

@@ -0,0 +1,47 @@
+// Injects a language toggle (EN / 中文) into the mdBook menu bar.
+// Swaps the leading /en-US/ <-> /zh-CN/ path segment, preserving the
+// rest of the path; falls back to the language root on 404 navigation.
+(function () {
+  const LANGS = [
+    { code: "en-US", label: "EN" },
+    { code: "zh-CN", label: "中文" },
+  ];
+
+  function currentLang() {
+    const m = window.location.pathname.match(/\/(en-US|zh-CN)\//);
+    return m ? m[1] : "en-US";
+  }
+
+  function swapTo(code) {
+    const path = window.location.pathname;
+    const cur = currentLang();
+    if (path.includes(`/${cur}/`)) {
+      return path.replace(`/${cur}/`, `/${code}/`);
+    }
+    return `/${code}/`;
+  }
+
+  function build() {
+    const right = document.querySelector(".right-buttons");
+    if (!right) return;
+    const cur = currentLang();
+    const wrap = document.createElement("div");
+    wrap.className = "lang-switcher";
+    wrap.style.display = "inline-flex";
+    wrap.style.gap = "0.5rem";
+    wrap.style.marginInlineStart = "0.5rem";
+    LANGS.forEach((l) => {
+      const a = document.createElement("a");
+      a.textContent = l.label;
+      a.href = swapTo(l.code);
+      a.title = l.code;
+      a.setAttribute("aria-current", l.code === cur ? "true" : "false");
+      if (l.code === cur) a.style.fontWeight = "bold";
+      wrap.appendChild(a);
+    });
+    right.appendChild(wrap);
+  }
+
+  if (document.readyState !== "loading") build();
+  else document.addEventListener("DOMContentLoaded", build);
+})();

docs/shared/termscp.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 500 500"><circle style="fill:#31363b" cx="250" cy="250" r="250"/><circle style="fill:#ea4444" cx="225" cy="40" r="7.344"/><circle style="fill:#eac944" cx="58.177" cy="22.745" r="7.344" transform="matrix(1, 0, 0, 1.031863, 191.822998, 16.530386)"/><circle style="fill:#34b938" cx="57.564" cy="22.269" r="7.344" transform="matrix(1, 0, 0, 1.031863, 217.43605, 17.021263)"/><polygon style="stroke:#000;fill:#f0f0f0" points="83.462 135.575 200 252.112 87.687 364.425 48.108 324.846 122.07 250.881 45.738 174.55"/><g transform="matrix(0.408921, 0, 0, 0.408921, 241.338654, 169.687912)"><polygon style="fill:#f0f0f0" points="196.4 0 292 49.2 388 98 292 147.2 196.4 196.4 100.8 147.2 4.8 98 100.8 49.2"/><polygon style="fill:#31363b" points="316 179.6 316 135.2 268 159.6 268 204 294.4 171.6"/><polygon style="fill:#f0f0f0" points="196.4 196.4 196.4 392.8 388 294.8 388 98 316 135.2 314.4 136 314.4 179.2 294.4 171.6 268 204 268 159.6"/><polygon style="fill:#f0f0f0" points="196.4 392.8 196.4 196.4 100.8 147.2 4.8 98 4.8 294.8"/><polygon style="fill:#31363b" points="76.8 61.2 268 159.6 314.4 136 316 135.2 124.8 36.8 100.8 49.2"/></g><rect style="fill:#f0f0f0" width="200" height="35.702" x="222.229" y="364.298" rx="10" ry="10"/></svg>

docs/zh-CN/README.md

@@ -0,0 +1,231 @@
+# termscp
+
+<p align="center">
+  <img src="/assets/images/termscp.svg" alt="termscp logo" width="256" height="256" />
+</p>
+
+<p align="center">~ 功能丰富的终端文件传输工具 ~</p>
+<p align="center">
+  <a href="https://termscp.rs" target="_blank">网站</a>
+  ·
+  <a href="https://termscp.rs/install" target="_blank">安装</a>
+  ·
+  <a href="https://docs.termscp.rs" target="_blank">用户手册</a>
+</p>
+
+<p align="center">
+  <a
+    href="https://github.com/veeso/termscp/blob/main/README.md"
+    ><img
+      height="20"
+      src="/assets/images/flags/gb.png"
+      alt="English"
+  /></a>
+</p>
+
+<p align="center">由 <a href="https://veeso.me/" target="_blank">@veeso</a> 开发</p>
+
+[![License-MIT](https://img.shields.io/crates/l/termscp.svg?logo=rust)](https://opensource.org/licenses/MIT)
+[![Repostars](https://img.shields.io/github/stars/veeso/termscp?style=flat&logo=github)](https://github.com/veeso/termscp/stargazers)
+[![Downloadscounter](https://img.shields.io/crates/d/termscp.svg?logo=rust)](https://crates.io/crates/termscp)
+[![Latest version](https://img.shields.io/crates/v/termscp.svg?logo=rust)](https://crates.io/crates/termscp)
+[![CI](https://github.com/veeso/termscp/workflows/CI/badge.svg?logo=github)](https://github.com/veeso/termscp/actions/workflows/ci.yml)
+
+---
+
+## 关于 termscp 🖥
+
+termscp 是一个功能丰富的终端文件浏览和传输工具，支持 SCP/SFTP/FTP/Kube/S3/WebDAV。 简而言之，它是一个带有 TUI 的终端工具，可以连接到远程服务器进行文件的检索和上传，并能够与本地文件系统进行交互。 它兼容 **Linux**、**MacOS**、**FreeBSD**、**NetBSD** 和 **Windows** 操作系统。
+
+![Explorer](assets/images/explorer.gif)
+
+---
+
+## 特性 🎁
+
+- 📁  支持多种通信协议
+  - **SFTP**
+  - **SCP**
+  - **FTP** 和 **FTPS**
+  - **Kube**
+  - **S3**
+  - **SMB**
+  - **WebDAV**
+- 🖥  使用便捷的 UI 在远程和本地文件系统上浏览和操作
+  - 创建、删除、重命名、搜索、查看和编辑文件
+- ⭐  通过“内置书签”和“最近连接”快速连接到您喜爱的主机
+- 📝  使用您喜欢的应用程序查看和编辑文件
+- 💁  使用 SSH 密钥和用户名/密码进行 SFTP/SCP 身份验证
+- 🐧  兼容 Windows、Linux、FreeBSD、NetBSD 和 MacOS 操作系统
+- 🐚  内置终端，可在系统上执行命令。
+- 🎨  丰富的个性化设置！
+  - 主题
+  - 自定义文件浏览器格式
+  - 可自定义的文本编辑器
+  - 可自定义的文件排序
+  - 以及许多其他参数...
+- 📫  传输大文件时通过桌面通知获得提醒
+- 🔭  与远程主机文件更改保持同步
+- 🔐  将密码保存在操作系统密钥保管库中
+- 🦀  由 Rust 提供强力支持
+- 👀  开发时更注重性能
+- 🦄  频繁的精彩更新
+
+---
+
+## 开始 🚀
+
+如果您正在考虑安装 termscp，我想对您表示感谢 💜 ！ 希望您会喜欢 termscp！  
+如果您想为此项目做出贡献，请不要忘记查看我们的[贡献指南](CONTRIBUTING.md)。
+
+如果您是 Linux、FreeBSD 或 MacOS 用户，使用以下简单的 shell 脚本即可通过单行指令在您的系统上安装 termscp：
+
+```sh
+curl --proto '=https' --tlsv1.2 -sSLf https://termscp.rs/install.sh | sh
+```
+
+> ❗ MacOS 安装需要 [Homebrew](https://brew.sh/)，否则将会安装 Rust 编译器
+
+如果您是 Windows 用户，则可以在 PowerShell 中通过单行指令安装 termscp：
+
+```ps
+irm https://termscp.rs/install.ps1 | iex
+```
+
+或者，使用 [Chocolatey](https://chocolatey.org/)：
+
+```ps
+choco install termscp
+```
+
+NetBSD 用户可以从官方仓库安装 termscp。
+
+```sh
+pkgin install termscp
+```
+
+Arch Linux 用户可以从官方仓库安装 termscp。
+
+```sh
+pacman -S termscp
+```
+
+如需更多信息或其他平台支持，请访问 [termscp.rs](https://termscp.rs/install) 查看所有安装方法。
+
+⚠️ 如果您想了解如何更新 termscp，只需从 CLI 运行 termscp： `(sudo) termscp update` ⚠️
+
+### 依赖 ❗
+
+- **Linux** 用户：
+  - libdbus-1
+  - pkg-config
+  - libsmbclient
+- **FreeBSD** 或 **NetBSD** 用户：
+  - dbus
+  - pkgconf
+  - libsmbclient
+
+### 可选依赖 ✔️
+
+这些依赖并非运行 termscp 的强制要求，但有助于享受其全部功能
+
+- **Linux/FreeBSD** 用户：
+  - 用 `V` **打开**文件（至少其中之一）
+    - *xdg-open*
+    - *gio*
+    - *gnome-open*
+    - *kde-open*
+- **Linux** 用户：
+  - 密钥环管理器：在[用户手册](https://docs.termscp.rs/zh-CN/configuration/password-security.html#linux-密钥环)中阅读更多内容
+- **WSL** 用户
+  - 用 `V` **打开**文件（至少其中之一）
+    - [wslu](https://github.com/wslutilities/wslu)
+
+---
+
+## 支持开发者 ☕
+
+如果您喜欢 termscp 并且感激我所做的工作，请考虑给予一点捐赠 🥳
+
+您可以通过以下平台之一进行捐赠：
+
+[![ko-fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/veeso)
+[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://www.paypal.me/chrisintin)
+
+---
+
+## 用户手册 📚
+
+用户手册可以在 [termscp 文档网站](https://docs.termscp.rs)上找到。
+
+---
+
+## 即将推出的功能 🧪
+
+请查看 [Milestones](https://github.com/veeso/termscp/milestones)
+
+---
+
+## 贡献和问题 🤝🏻
+
+欢迎贡献、bug 报告、新功能和问题！ 😉
+如果您有任何问题或困惑，或者想建议新功能，或者只是想改进 termscp，请随时打开 issue 或 PR。
+
+一个**值得赞赏**的贡献是将用户手册和 README 翻译成**其他语言**
+
+请遵循[我们的贡献指南](CONTRIBUTING.md)
+
+---
+
+## 更新日志 ⏳
+
+查看 termscp 的更新日志[点此](CHANGELOG.md)
+
+---
+
+## 支持 💪
+
+termscp 由这些很棒的项目提供支持：
+
+- [bytesize](https://github.com/hyunsik/bytesize)
+- [crossterm](https://github.com/crossterm-rs/crossterm)
+- [edit](https://github.com/milkey-mouse/edit)
+- [keyring-rs](https://github.com/hwchen/keyring-rs)
+- [kube](https://github.com/kube-rs/kube)
+- [open-rs](https://github.com/Byron/open-rs)
+- [pavao](https://github.com/veeso/pavao)
+- [remotefs](https://github.com/veeso/remotefs-rs)
+- [rpassword](https://github.com/conradkleinespel/rpassword)
+- [self_update](https://github.com/jaemk/self_update)
+- [ratatui](https://github.com/ratatui-org/ratatui)
+- [tui-realm](https://github.com/veeso/tui-realm)
+- [whoami](https://github.com/libcala/whoami)
+- [wildmatch](https://github.com/becheran/wildmatch)
+
+---
+
+## 演示 🎬
+
+> termscp 首页
+
+![Auth](assets/images/auth.gif)
+
+> 书签
+
+![Bookmarks](assets/images/bookmarks.gif)
+
+> 设置
+
+![Setup](assets/images/config.gif)
+
+> 文本编辑器
+
+![TextEditor](assets/images/text-editor.gif)
+
+---
+
+## 许可协议 📃
+
+termscp 使用 MIT 许可证授权。
+
+您可以阅读完整的[许可证](LICENSE)

docs/zh-CN/SUMMARY.md

@@ -0,0 +1,37 @@
+# 目录
+
+[简介](index.md)
+
+# 入门
+
+- [安装](getting-started/installation.md)
+- [连接到服务器](getting-started/connecting.md)
+- [连接参数](getting-started/connection-parameters.md)
+
+# 使用 termscp
+
+- [文件浏览器](usage/file-explorer.md)
+- [键盘快捷键](usage/keyboard-shortcuts.md)
+- [批量操作文件](usage/multiple-files.md)
+- [同步浏览](usage/synced-browsing.md)
+- [打开与编辑文件](usage/open-edit-files.md)
+- [书签与最近主机](usage/bookmarks.md)
+- [保持文件同步](usage/file-watcher.md)
+
+# 配置
+
+- [配置](configuration/configuration.md)
+- [文件浏览器格式](configuration/explorer-format.md)
+- [SSH 密钥存储](configuration/ssh-keys.md)
+- [主题](configuration/themes.md)
+- [通知](configuration/notifications.md)
+- [日志](configuration/logging.md)
+- [密码安全](configuration/password-security.md)
+
+# 命令行参考
+
+- [命令行用法](cli/cli.md)
+
+# 开发者
+
+- [开发者手册](developer/developer.md)