Compare commits

..

549 Commits

Author SHA1 Message Date
veeso f54c50f6ef chore: release v1.2.0 2026-09-03 11:57:52 +00:00
Christian Visintin 325c8ceee7 ci(release): add dprint 2026-09-03 13:57:03 +02:00
Christian Visintin ebfaeb956c chore(release): release 1.2.0 (#448) 2026-09-03 13:44:07 +02:00
Christian Visintin 133ec898d8 ci(release): build Linux artifacts as static musl binaries (#447)
Build Linux release artifacts as statically linked musl binaries for x86_64 and aarch64, update packaging and updater handling, and document the reduced runtime requirements.

Keep release version preparation locked without refreshing dependencies or committing Cargo.lock.

Closes #440
2026-09-03 13:31:16 +02:00
Christian Visintin 1587d3d625 build: bump remotefs-smb 0.5.0 (#446)
CI / toolchain (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / install-scripts (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Site / build-site (push) Has been cancelled
CI / crates-macos-latest (push) Has been cancelled
CI / crates-ubuntu-latest (push) Has been cancelled
CI / crates-windows-latest (push) Has been cancelled
CI / doc (push) Has been cancelled
CI / deny (push) Has been cancelled
* build: bump remotefs-smb 0.5.0

* fix(smb): windows build
2026-09-03 10:20:33 +02:00
Christian Visintin 751f68f6d4 feat(smb): add SMB dialect selection and persistence (#445)
Deploy docs to GitHub Pages / deploy (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
CI / toolchain (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / install-scripts (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Site / build-site (push) Has been cancelled
CI / crates-macos-latest (push) Has been cancelled
CI / crates-ubuntu-latest (push) Has been cancelled
CI / crates-windows-latest (push) Has been cancelled
CI / doc (push) Has been cancelled
CI / deny (push) Has been cancelled
Support Auto, SMB1, SMB2, and SMB3 selection on Unix, bound negotiation to the selected dialect family, preserve legacy bookmarks as Auto, and document the new option. Windows keeps operating-system-managed negotiation.

Closes #439
2026-09-02 14:14:23 +02:00
Christian Visintin e966a83220 chore(just): add run_signed script
Deploy docs to GitHub Pages / deploy (push) Has been cancelled
CI / toolchain (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / install-scripts (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Site / build-site (push) Has been cancelled
CI / crates-macos-latest (push) Has been cancelled
CI / crates-ubuntu-latest (push) Has been cancelled
CI / crates-windows-latest (push) Has been cancelled
CI / doc (push) Has been cancelled
CI / deny (push) Has been cancelled
2026-09-01 12:52:10 +02:00
Christian Visintin d99c76b43c feat(ssh): auto-fill ssh config parameters in auth form
Resolve SSH host parameters in auth forms and CLI connections while preserving explicit user, bookmark, and parsed alias values. Continue forwarding SSH config files for HostName and other SSH options, and document the precedence in English and Chinese.

Closes #441
2026-09-01 12:52:10 +02:00
Christian Visintin 7434c51063 feat: add support for all ssh2 config parameters.
Achieved by bumping `remotefs-ssh` to `0.9`.

Added support for these parameters:

- Compression
- Host key certificates
- CA signature algorithms
- keys to agents
- ProxyJump
- Server alive intervals
- Agent forwarding
- Remote forwarding
- Bind address
- Bind interface
- Connection attempts
- TCP Keepalive
- Accepted public key algos
- Certificate files

Refs #441
2026-09-01 12:52:10 +02:00
Christian Visintin 9fbd617f88 fix: print actual reason for failed host params collecting
previously, we didn't show any reason for failed collecting of host params in the auth form, but just a generic message

refs #441
2026-09-01 12:52:10 +02:00
Christian Visintin 2bbe560ec5 chore: remove invalid advisories for remotefs-aws-s3
CI / toolchain (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / install-scripts (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Deploy docs to GitHub Pages / deploy (push) Has been cancelled
Site / build-site (push) Has been cancelled
CI / crates-macos-latest (push) Has been cancelled
CI / crates-ubuntu-latest (push) Has been cancelled
CI / crates-windows-latest (push) Has been cancelled
CI / doc (push) Has been cancelled
CI / deny (push) Has been cancelled
2026-08-30 21:48:21 +02:00
Christian Visintin 7472ca98a0 chore: add AI_POLICY and update Pull request template 2026-08-30 21:47:28 +02:00
Christian Visintin 974b6d6917 feat(gcs): add Google Cloud Storage support (#443)
* feat(gcs): add Google Cloud Storage support

Closes #436

* fix: honor configured protocol and finalization errors

* ci: remove TruffleHog checks
2026-08-30 18:58:17 +02:00
Christian Visintin 98a1ce42dc build(deps): update aes-gcm to 0.11
CI / toolchain (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / install-scripts (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Site / build-site (push) Has been cancelled
CI / crates-macos-latest (push) Has been cancelled
CI / crates-ubuntu-latest (push) Has been cancelled
CI / crates-windows-latest (push) Has been cancelled
CI / doc (push) Has been cancelled
CI / deny (push) Has been cancelled
Migrate nonce generation and parsing to the aes-gcm 0.11 API while preserving the encrypted payload format.
2026-08-29 14:06:27 +02:00
Christian Visintin afbc74113f ci: migrate project automation to Just (#442)
Deploy docs to GitHub Pages / deploy (push) Has been cancelled
Site / build-site (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
CI / toolchain (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / install-scripts (push) Has been cancelled
CI / crates-ubuntu-latest (push) Has been cancelled
CI / crates-windows-latest (push) Has been cancelled
CI / doc (push) Has been cancelled
CI / deny (push) Has been cancelled
CI / crates-macos-latest (push) Has been cancelled
* ci: migrate project automation to Just

Centralize build, test, release, dependency, hook, and website commands in Just recipes. Pin workflow tooling, use the repository toolchain, and run the complete validation set in CI.

* ci: codex being codex

* docs: update CLAUDE.md for just task runner migration

Reflect the switch to just recipes for build/test/clippy/fmt, note
dprint replacing raw rustfmt, and add a cross-platform code requirement.

* fix: resolve clippy warnings breaking CI on ubuntu and windows

Use clone() instead of implicit to_string() on already-owned String
values, gate the windows-only unused make_file_at import behind
cfg(posix), and fix unused mut / manual assign-op in the windows-only
localhost test.

* fix: fmt
2026-08-28 19:29:58 +02:00
Christian Visintin 08c51a32cc ci: remove Codeberg mirror workflow. I do not support Codeberg mission anymore
CI / build-(macos-latest) (push) Has been cancelled
CI / build-(ubuntu-latest) (push) Has been cancelled
CI / build-(windows-latest) (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Site / build-site (push) Has been cancelled
2026-07-29 22:41:06 +02:00
Christian Visintin 739517f7e4 feat(site): add privacy policy page (#435)
codeberg-mirror / mirror (push) Has been cancelled
CI / build-(macos-latest) (push) Has been cancelled
CI / build-(ubuntu-latest) (push) Has been cancelled
CI / build-(windows-latest) (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Site / build-site (push) Has been cancelled
Add a GDPR privacy policy covering Vercel hosting/server logs and
EU-hosted Umami analytics, and link it from the footer.
2026-06-19 19:12:53 +02:00
Christian Visintin 77281ed926 fix(publish): anchor include globs to crate root
CI / build-(macos-latest) (push) Has been cancelled
CI / build-(ubuntu-latest) (push) Has been cancelled
CI / build-(windows-latest) (push) Has been cancelled
codeberg-mirror / mirror (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Site / build-site (push) Has been cancelled
Unanchored include patterns (LICENSE, README.md) matched at any depth
via gitignore-glob semantics, pulling 437 site/node_modules files into
the package and breaking cargo publish's dirty check.
2026-06-08 21:18:43 +02:00
Christian Visintin 4b6325ebe3 chore: update Cargo.lock 2026-06-08 21:15:21 +02:00
Christian Visintin 6933a98cda chore(Cargo.lock): update Cargo.lock 2026-06-08 21:14:39 +02:00
veeso 5cee1184dc chore: release v1.1.1 2026-06-08 18:54:35 +00:00
Christian Visintin 4a9da89642 fix(build): drop vergen-git2 build dependency
vergen-git2 reads git metadata at build time, but the crates.io source
tarball ships no .git, so the published 1.1.0 fails on `cargo install`.
crates.io versions are immutable (no overwrite) and Chocolatey's
moderation queue blocks a fast re-push, so a clean 1.1.1 without vergen
is the only fix.
2026-06-08 20:53:55 +02:00
veeso 282f75c3f3 chore: release v1.1.0 2026-06-08 18:17:39 +00:00
Christian Visintin 535ed23540 chore: update cliff config 2026-06-08 20:17:02 +02:00
Christian Visintin 70bd7d7330 fix(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.
2026-06-08 20:17:02 +02:00
Christian Visintin 352eec4762 chore(Cargo.toml): bump 1.1.0 2026-06-08 20:17:02 +02:00
Christian Visintin 3a5327f5b1 ci(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.
2026-06-08 20:17:02 +02:00
Christian Visintin b1601fb17e chore(deps): migrate keyring from 3 to 4
keyring v4 is no longer a library crate; the API moved to keyring-core
plus per-platform credential store crates. Replace the keyring dependency
with keyring-core and the native store crates, and register the default
store at runtime (lazily, once) since v4 no longer selects it at compile
time via Cargo features.
2026-06-08 20:17:02 +02:00
Christian Visintin bca261b7b2 chore(deps): bump aes, cbc, md-5, rand and vergen-git2
Migrate to the new RustCrypto cipher 0.5 traits (aes 0.9, cbc 0.2),
rand 0.10 and vergen-git2 10, whose APIs changed:

- vergen-git2: builders renamed (BuildBuilder -> Build, etc.) and the
  all_* constructors no longer return a Result
- aes/cbc: BlockDecryptMut -> BlockModeDecrypt and
  decrypt_padded_vec_mut -> decrypt_padded_vec
- rand: sample API moved
2026-06-08 20:17:02 +02:00
Christian Visintin 904befaea8 fix(copy): prevent emptying file when copy destination is empty (#421)
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
CI / build-(macos-latest) (push) Has been cancelled
CI / build-(ubuntu-latest) (push) Has been cancelled
CI / build-(windows-latest) (push) Has been cancelled
codeberg-mirror / mirror (push) Has been cancelled
Deploy docs to GitHub Pages / deploy (push) Has been cancelled
Site / build-site (push) Has been cancelled
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.

Closes #421
2026-06-08 17:12:52 +02:00
Christian Visintin afe7b05830 docs(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.
2026-06-08 16:39:24 +02:00
Christian Visintin 837592e48a feat(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.

Closes #431
2026-06-08 16:39:24 +02:00
Christian Visintin ab5de031e3 ci(site): always run site 2026-06-08 16:02:27 +02:00
Christian Visintin f3085161e6 fix(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.
2026-06-08 16:02:27 +02:00
Christian Visintin 1dafc76850 fix(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.
2026-06-08 16:02:27 +02:00
Christian Visintin f066d6a387 chore(readme): remove current version 2026-06-08 10:43:35 +02:00
Christian Visintin 987751d732 chore(site): add site umami analytics 2026-06-08 10:43:35 +02:00
Christian Visintin 1ca8abbfe8 ci: rename ci workflow 2026-06-08 10:16:00 +02:00
Christian Visintin 26e71a2f1d ci(release): publish to crates.io via OIDC trusted publishing 2026-06-08 10:16:00 +02:00
Christian Visintin b1d77c78fe fix(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
2026-06-08 10:16:00 +02:00
Christian Visintin 2a7d48a92b ci: unify os workflows into one 2026-06-08 10:16:00 +02:00
Christian Visintin 82141e7f2b chore: remove ko-fi 2026-06-08 10:16:00 +02:00
Christian Visintin 14bc15cfca chore(site): update og_preview 2026-06-08 10:16:00 +02:00
Christian Visintin 85fa99e4cc docs(zh): fix keyring deep-link anchor to translated heading slug 2026-06-08 10:16:00 +02:00
Christian Visintin 3ff3cdb587 ci: add github pages workflow for docs site 2026-06-08 10:16:00 +02:00
Christian Visintin 726443ae21 docs: fix update command (termscp update, not --update) in READMEs 2026-06-08 10:16:00 +02:00
Christian Visintin 0bd449e7bc docs(zh): align README with root README, drop dead language links 2026-06-08 10:16:00 +02:00
Christian Visintin c24f08691d docs: drop extra language docs/READMEs, point manual links to docs.termscp.rs 2026-06-08 10:16:00 +02:00
Christian Visintin 14e6872432 docs: disable MD060 table alignment (incompatible with CJK width) 2026-06-08 10:16:00 +02:00
Christian Visintin 88900a80b8 docs(zh): translate cli reference and developer pages 2026-06-08 10:16:00 +02:00
Christian Visintin ce619bcff2 docs(zh): translate configuration pages 2026-06-08 10:16:00 +02:00
Christian Visintin 5a16467e71 docs(zh): translate usage pages 2026-06-08 10:16:00 +02:00
Christian Visintin b6ca8c57f0 docs(zh): translate section headings in getting-started pages 2026-06-08 10:16:00 +02:00
Christian Visintin 660c17a0df docs(zh): translate introduction and getting-started pages 2026-06-08 10:16:00 +02:00
Christian Visintin aed4ecc522 docs: scaffold zh-CN mdbook 2026-06-08 10:16:00 +02:00
Christian Visintin ee69ba6ef8 docs: add markdownlint config for docs site 2026-06-08 10:16:00 +02:00
Christian Visintin 0db3ea43d2 docs(en): fix CLI references (no -t / --update flags; -b is a value option) 2026-06-08 10:16:00 +02:00
Christian Visintin 6a61eb16f7 docs(en): write cli reference and developer pages 2026-06-08 10:16:00 +02:00
Christian Visintin e32ed613cc docs(en): write configuration pages 2026-06-08 10:16:00 +02:00
Christian Visintin dbd61f0fab docs(en): write usage pages 2026-06-08 10:16:00 +02:00
Christian Visintin a18fa0ca5a docs(en): write introduction and getting-started pages 2026-06-08 10:16:00 +02:00
Christian Visintin c8846266d7 docs: add en-US table of contents 2026-06-08 10:16:00 +02:00
Christian Visintin 40440832be docs: scaffold en-US mdbook 2026-06-08 10:16:00 +02:00
Christian Visintin 34c03841be docs: add CNAME for docs.termscp.rs 2026-06-08 10:16:00 +02:00
Christian Visintin ded71dce48 docs: add mdbook language switcher script 2026-06-08 10:16:00 +02:00
Christian Visintin eefa1b3db0 docs: add shared mdbook assets and favicon.ico 2026-06-08 10:16:00 +02:00
Christian Visintin a2d766d688 ci(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.
2026-06-08 10:16:00 +02:00
Christian Visintin f92cb93755 feat(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
2026-06-08 10:16:00 +02:00
Christian Visintin d070825dd7 chore(install.sh): remove reference to changelog 2026-06-08 10:16:00 +02:00
Christian Visintin 3774156873 docs: replace last termscp.veeso.dev refs (install.sh manual/changelog, crate homepage) 2026-06-08 10:16:00 +02:00
Christian Visintin bbeefc557e fix(site): drop @ts-check on astro config to clear false vite type error 2026-06-08 10:16:00 +02:00
Christian Visintin 3ee21aba2f docs: point READMEs to termscp.rs + install.sh, docs.termscp.rs 2026-06-08 10:16:00 +02:00
Christian Visintin 6cf5bf18cf ci: remove pages workflow, fix release version-bump for astro site 2026-06-08 10:16:00 +02:00
Christian Visintin d7b7ab7fa1 feat(site): robots, sitemap reference, vercel redirects + cache headers 2026-06-08 10:16:00 +02:00
Christian Visintin 48b387de14 chore(site): remove ko-fi, add astro check dep, drop unused explorer media 2026-06-08 10:16:00 +02:00
Christian Visintin e381484022 refactor(site): english-only, remove i18n machinery 2026-06-08 10:16:00 +02:00
Christian Visintin 203a6da387 build(site): copy install.sh from repo root at build time (single source) 2026-06-08 10:16:00 +02:00
Christian Visintin 3379940ec9 feat(site): install page led by install.sh script, package-manager tabs 2026-06-08 10:16:00 +02:00
Christian Visintin 2153164484 fix(site): hero selected-row contrast (latte) + mobile row truncation 2026-06-08 10:16:00 +02:00
Christian Visintin 0cc7362bd9 refactor(site): drop in-site manual, link to external docs.termscp.rs 2026-06-08 10:16:00 +02:00
Christian Visintin 5c84a0e88d feat(site): landing page with dual-pane explorer hero 2026-06-08 10:16:00 +02:00
Christian Visintin a25b17a4e5 feat(site): responsive mobile nav, css-driven theme icons, localizePath helper 2026-06-08 10:16:00 +02:00
Christian Visintin d670aed079 feat(site): nav, footer, theme toggle, language picker 2026-06-08 10:16:00 +02:00
Christian Visintin 6fa3c042b1 feat(site): x-default hreflang, twitter card, og:image:alt; dedupe locales/site in base layout 2026-06-08 10:16:00 +02:00
Christian Visintin fc7e789390 feat(site): base layout with og/hreflang, theme bootstrap, umami 2026-06-08 10:16:00 +02:00
Christian Visintin 3c4356af92 fix(site): robust man-fetch invocation guard, add timeout+retry 2026-06-08 10:16:00 +02:00
Christian Visintin ba513850c1 feat(site): build-time man.md fetcher pinned to release ref 2026-06-08 10:16:00 +02:00
Christian Visintin f56dd60868 refactor(site): type-safe i18n keys derived from en 2026-06-08 10:16:00 +02:00
Christian Visintin f544a63d19 feat(site): i18n string resolver with en fallback 2026-06-08 10:16:00 +02:00
Christian Visintin 02fec64d35 feat(site): catppuccin theme tokens, tailwind 4, self-hosted font 2026-06-08 10:16:00 +02:00
Christian Visintin a54ff078cc chore(site): scaffold astro project, remove legacy SPA 2026-06-08 10:16:00 +02:00
Christian Visintin c27748272d chore: gitignore .superpowers brainstorm artifacts 2026-06-08 10:16:00 +02:00
Christian Visintin f6d65cf09d ci: fix release notes generation in release workflow
Deploy static content to Pages / deploy (push) Has been cancelled
codeberg-mirror / mirror (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Linux / build-linux (push) Has been cancelled
MacOS / build-macos (push) Has been cancelled
Windows / build-windows (push) Has been cancelled
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
2026-06-07 19:16:00 +02:00
Christian Visintin 930e76814f 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.
2026-06-07 16:58:51 +02:00
Christian Visintin cdd4c60805 ci: 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.
2026-06-07 16:58:51 +02:00
Christian Visintin c652ca18b8 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
2026-06-07 16:58:51 +02:00
Christian Visintin 0ad18ea5e7 chore: update release date
Close inactive issues / close-issues (push) Has been cancelled
codeberg-mirror / mirror (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Linux / build-linux (push) Has been cancelled
MacOS / build-macos (push) Has been cancelled
Deploy static content to Pages / deploy (push) Has been cancelled
Windows / build-windows (push) Has been cancelled
2026-04-18 22:25:40 +02:00
Christian Visintin 2ed71c7ff8 chore: 1.0.0 changelog 2026-04-19 01:54:46 +05:30
Christian Visintin 49102985a4 ci: add linux and windows aarch64 build targets 2026-04-19 01:54:46 +05:30
Christian Visintin bc59df494b fix: 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.

Closes #410
2026-04-19 01:54:46 +05:30
Christian Visintin 080c013fab build: upgrade remotefs-ssh to 0.8.3
closes #414
2026-04-19 01:54:46 +05:30
Christian Visintin 6252df2959 build: 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.
2026-04-19 01:54:46 +05:30
Christian Visintin 9160c52cb0 build: remotefs-ssh 0.8.2
this version removes any usage of sh commands from the sftp backend and only uses pure protocol functions

closes #409
2026-04-19 01:54:46 +05:30
Christian Visintin 38f1fccfd0 build: remotefs-ssh 0.8.1 2026-04-19 01:54:46 +05:30
Christian Visintin 6ceaf048b5 fix: 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.
2026-04-19 01:54:46 +05:30
Christian Visintin 534c16427e fix: 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.
2026-04-19 01:54:46 +05:30
Christian Visintin 9b19240925 feat: consolidate theme progress bar fields into single transfer_progress_bar 2026-04-19 01:54:46 +05:30
Christian Visintin 0ddbf3b104 feat: update transfer loop to use unified TransferProgress 2026-04-19 01:54:46 +05:30
Christian Visintin 126e58503f feat: update progress bar display for new unified data model 2026-04-19 01:54:46 +05:30
Christian Visintin 0be8b60c7d feat: simplify progress bar layout to single component 2026-04-19 01:54:46 +05:30
Christian Visintin 4ed6b118ca feat: replace dual progress bar components with single TransferProgressBar 2026-04-19 01:54:46 +05:30
Christian Visintin a48b226d9b feat: rework TransferProgress to track bytes with lazy estimation 2026-04-19 01:54:46 +05:30
Christian Visintin e11af03fdd chore: enable safe clippy pedantic lints 2026-04-19 01:54:46 +05:30
Christian Visintin f044e6ace2 docs: document ssh key storage API 2026-04-19 01:54:46 +05:30
Christian Visintin e056afbd28 test: extend system regression coverage 2026-04-19 01:54:46 +05:30
Christian Visintin 9442e3b150 fix: normalize localhost relative path checks 2026-04-19 01:54:46 +05:30
Christian Visintin 9c00b9a86c test: extend config and explorer regression coverage 2026-04-19 01:54:46 +05:30
Christian Visintin 622cfe260a test: add parser and bookmark regression coverage 2026-04-19 01:54:46 +05:30
Christian Visintin 0c3ced012e refactor: split auth view helpers by responsibility 2026-04-19 01:54:46 +05:30
Christian Visintin d60c5007f9 docs: complete remaining core module docs 2026-04-19 01:54:46 +05:30
Christian Visintin 7e10b8e68b docs: document parser and file transfer params 2026-04-19 01:54:46 +05:30
Christian Visintin 08509caf1b docs: document core host and ssh modules 2026-04-19 01:54:46 +05:30
Christian Visintin 89de2d2dfa docs: add core module and API documentation 2026-04-19 01:54:46 +05:30
Christian Visintin abc80b93ad refactor: split auth update handlers by context 2026-04-19 01:54:46 +05:30
Christian Visintin 1b79a6fc91 refactor: split auth form components by protocol 2026-04-19 01:54:46 +05:30
Christian Visintin 5a3aa64fba refactor: split parser internals into focused modules 2026-04-19 01:54:46 +05:30
Christian Visintin bc4b096077 fix: 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.
2026-04-19 01:54:46 +05:30
Christian Visintin 0025b87b0f fix: sync browsing when entering a directory from filtered/fuzzy view
Closes #382
2026-04-19 01:54:46 +05:30
Christian Visintin bd0843d3da build: replace version-compare crate with semver
closes #399
2026-04-19 01:54:46 +05:30
Christian Visintin 0ba43d5714 ci: check fmt with nightly toolchain 2026-04-19 01:54:46 +05:30
Christian Visintin 97e1ca789a chore: add fmt+clippy convention to CLAUDE.md and apply nightly fmt 2026-04-19 01:54:46 +05:30
Christian Visintin 2df13fac10 fix: 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.
2026-04-19 01:54:46 +05:30
Christian Visintin 186313f57c fix: 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.

Closes #402
2026-04-19 01:54:46 +05:30
Christian Visintin 8b0be49609 ci: run test workflows once 2026-04-19 01:54:46 +05:30
Christian Visintin e062ee0447 chore: format toml 2026-04-19 01:54:46 +05:30
Christian Visintin c81cf39fe9 build: replaced libssh with russh for remotefs-ssh 2026-04-19 01:54:46 +05:30
Christian Visintin 9cfef867a9 fix: return after empty terminal prompt 2026-04-19 01:54:46 +05:30
Christian Visintin 18314e6a2e chore: 1.0.0 version into manifests 2026-04-19 01:54:46 +05:30
Christian Visintin 9f3df1a79a style: linter 2026-04-19 01:54:46 +05:30
Christian Visintin fe424107e9 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

closes #398
2026-04-19 01:54:46 +05:30
Christian Visintin d97535894c fix: 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.

Closes #384
2026-04-19 01:54:46 +05:30
Christian Visintin 4d65e48b3c fix: 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.
2026-04-19 01:54:46 +05:30
Christian Visintin 0d24662b3d refactor: migrate from mod.rs to named module files 2026-04-19 01:54:46 +05:30
Christian Visintin bc14b049c0 chore: add centralized lint configuration to Cargo.toml 2026-04-19 01:54:46 +05:30
Christian Visintin d32c588f15 refactor: replace lazy_static with std::sync::LazyLock 2026-04-19 01:54:46 +05:30
Christian Visintin 60e86aff2a perf: use sort_by_cached_key to avoid repeated lowercase allocations in file sorting 2026-04-19 01:54:46 +05:30
Christian Visintin 5f83a1468c fix: correct typos in BadSytax and theme_provider log messages 2026-04-19 01:54:46 +05:30
Christian Visintin 5758a12c3b fix: replace assert! calls in UI activities with graceful error handling 2026-04-19 01:54:46 +05:30
Christian Visintin 49a74d02ea fix: replace panics reachable from user input with proper error handling 2026-04-19 01:54:46 +05:30
Christian Visintin f6d35f1eea refactor: 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.
2026-04-19 01:54:46 +05:30
Christian Visintin 3fb61a76fe chore: funding
MacOS / build (push) Has been cancelled
Deploy static content to Pages / deploy (push) Has been cancelled
Windows / build (push) Has been cancelled
codeberg-mirror / mirror (push) Has been cancelled
Install.sh / build (macos-latest) (push) Has been cancelled
Install.sh / build (ubuntu-latest) (push) Has been cancelled
Linux / build (push) Has been cancelled
Close inactive issues / close-issues (push) Has been cancelled
2026-02-24 12:33:58 +01:00
Christian Visintin ff4452c971 chore: WTF CTRL SAVE DOESNT FUCKING WORK 2026-02-09 10:27:21 +01:00
Christian Visintin fd1d8a0e26 chore: Install with apt if installed 2026-02-09 10:25:57 +01:00
Christian Visintin b0d6da8e23 chore: Copilot is so dumb 2026-02-09 10:12:54 +01:00
Christian Visintin 4ca0865fe3 chore: Use apt to install termscp on debian base to prevent broken deps 2026-02-09 10:12:04 +01:00
Christian Visintin b8115362f8 ci: Codeberg mirroring 2026-01-30 14:57:03 +01:00
Christian Visintin 155f747563 docs: date 2025-12-20 17:12:50 +01:00
Christian Visintin b04976bde3 fix: Updated dependencies to allow build on NetBSD
closes #371
2025-12-20 16:33:50 +01:00
veeso 5f7a0d8a46 fix: install.sh deb name
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Close inactive issues / close-issues (push) Has been cancelled
2025-12-02 14:27:34 +01:00
veeso 694232564a fix: install.sh deb name 2025-12-02 14:25:55 +01:00
veeso 54b674ad43 ci: windows artifact name
Deploy static content to Pages / deploy (push) Has been cancelled
Windows / build (push) Has been cancelled
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Close inactive issues / close-issues (push) Has been cancelled
2025-11-11 12:34:36 +01:00
veeso c32822037e ci: deploy site 2025-11-11 12:21:05 +01:00
veeso abb5c212c5 feat: Merge branch '0.19.0' 2025-11-11 12:19:21 +01:00
veeso e9b54a227b chore: CHANGELOG date 2025-11-11 09:42:21 +01:00
veeso befc32198a ci: debian fix
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2025-11-10 17:25:29 +01:00
veeso 7e5103ff7e ci: Debian 2025-11-10 17:06:44 +01:00
veeso 2cb600083e docs: Release date 2025-11-10 16:44:24 +01:00
Christian Visintin 47d23673e6 ci: Build artifacts for Windows x86_64 and Ubuntu x86_64 (#368) 2025-11-10 16:43:25 +01:00
Christian Visintin a0b357cf8c feat: Added <CTRL+S> keybinding to get the total size of selected paths. (#367)
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
* feat: Added `<CTRL+S>` keybinding to get the total size of selected paths.

closes #297
2025-11-09 21:14:42 +01:00
Christian Visintin 75943f2b93 feat: Changed file overwrite behaviour (#366)
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Now the user can choose for each file whether to overwrite, skip or overwrite all/skip all.

closes #335
2025-11-09 19:00:17 +01:00
veeso 085ab721f9 build: remotefs-ssh 0.7.1
This version fixes compatibility with hosts which don't use bash/sh as the default shell.

closes #365
2025-11-09 17:38:50 +01:00
Christian Visintin f4156a5059 feat: Import bookmarks from ssh config with a CLI command (#364)
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
* 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

closes #331
2025-11-08 15:32:52 +01:00
Christian Visintin 4bebec369f fix: Issues with update checks (#363)
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
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.

closes #354
2025-10-02 21:27:51 +02:00
Christian Visintin 05c8613279 fix: 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.

closes #361

* ci: windows runner
2025-10-02 20:58:26 +02:00
veeso 205d2813ad perf: Migrated to libssh.org on Linux and MacOS for better ssh agent support.
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
closes #337
2025-09-20 18:13:20 +02:00
veeso 86660a0cc9 fix: SMB support for MacOS with vendored build of libsmbclient.
closes #334
2025-09-20 18:07:26 +02:00
veeso 05830db206 docs: User manual and get started links
Install.sh / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Linux / build (push) Has been cancelled
Close inactive issues / close-issues (push) Has been cancelled
2025-09-16 10:36:17 +02:00
veeso 3c79e812eb build: 0.19 deps 2025-09-06 16:40:01 +02:00
moshyfawn 0287e7706a fix: typo in file open error message (#349)
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Close inactive issues / close-issues (push) Has been cancelled
2025-06-13 22:50:06 +02:00
veeso 67a14c2725 fix: lock
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2025-06-10 21:20:04 +02:00
veeso df03c5c1bf feat: 0.18
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2025-06-10 14:29:02 +02:00
veeso 3ce3ffee3d fix: larger file info popup 2025-06-10 14:26:36 +02:00
Christian Visintin c0b32a1847 feat: Replaced the Exec popup with a fully functional terminal emulator (#348)
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
* feat: Replaced the `Exec` popup with a fully functional terminal emulator

closes #340

* fix: colors and fmt for terminal

* feat: Handle exit and cd on terminal

* fix: Fmt pah
2025-06-10 13:17:20 +02:00
Christian Visintin 81ae0035c3 Fix SSH auth with id keys (#347)
I fixed the id_rsa/id_ed25519 SSH auth issue on Mac and now termscp should respect the key-based authentication, just like the regular ssh user@hostname, without the need for any ssh agents.

---

Co-authored-by: Lucas Czekaj <lukasz@czekaj.us>
2025-06-08 18:34:59 +02:00
veeso 783da22ca2 feat: **Updated dependencies** and updated the Rust edition to 2024 2025-06-08 18:00:42 +02:00
veeso 8715c2b6f9 chore: CODE_OF_CONDUCT update
Install.sh / build (push) Has been cancelled
2025-05-10 19:23:06 +02:00
veeso 98a748dccc style: catppuccin themes
Install.sh / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Linux / build (push) Has been cancelled
2025-04-15 12:24:08 +02:00
Christian Visintin bef031a414 Update website.yml
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2025-03-23 22:01:18 +01:00
veeso ce0e953182 chore: site 2025-03-23 18:13:05 +01:00
veeso 9a5caf75c3 build: so apparently native-tls vendored tries to build openssl on windows, wtf guys?
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2025-03-23 18:07:20 +01:00
veeso 446f4a3a32 build: build docker for x86 2025-03-23 16:43:51 +01:00
veeso da75912d26 docs: version
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
2025-03-23 15:59:50 +01:00
veeso 4ed23c2a18 build: aws-s3 0.4.2 2025-03-23 15:58:25 +01:00
Christian Visintin 23ae334bef ci(build): build vendored smb and refactor platform deps (#333) 2025-03-23 15:57:54 +01:00
Christian Visintin ec75ae1486 feat: 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`.

closes #132
2025-03-23 14:36:13 +01:00
veeso 368570592f feat(cli): added --wno-keyring flag to disable keyring
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
closes #308
2025-03-22 13:44:02 +01:00
veeso 806793421e fix(bookmarks): Local directory path is not switching to what's specified in the bookmark
closes #316
2025-03-22 13:25:29 +01:00
veeso 1f377b242d fix(log): add suppaftp/pavao/kube to allowed logs
Windows / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
fix #330
2025-03-17 18:59:47 +01:00
veeso a4906b129a docs: veeso.me instead of veeso.dev
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
2025-03-17 09:31:44 +01:00
veeso 5c6e8925ad test(remotefs_builder): check result, build doesn't panic anymore 2025-03-17 09:30:33 +01:00
veeso a18eff689d fix(aws-s3): updated remotefs-aws-s3 to 0.4.1
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
should fix #329
2025-03-16 20:06:35 +01:00
veeso 274742d6d9 build: bump to ssh2-config 0.4 and remotefs 0.6 to have support for Include in config files
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
fix #309
2025-03-15 20:04:21 +01:00
veeso cdebcbd4dc fix: the return value of --version should be 0
fix #317
2025-03-15 16:54:36 +01:00
veeso cdf303a847 fix: fixed a crash when the local directory specified in the auth form does not exist
fix #319
2025-03-15 16:46:57 +01:00
veeso dd35fe825c fix(ui): fixed input mask on host bridge on local dir up
if you go up on local dir when localhost is selected it panics

fix #327
2025-03-15 14:24:24 +01:00
veeso 5c4a971aca docs(CONTRIBUTING): docs(CONTRIBUTING): mistakes
fix #318
2025-03-15 14:19:18 +01:00
veeso 7522b4d0ff chore(changelog): changelog 2025-03-15 14:16:18 +01:00
veeso b0f314837e build(deps): updated dependencies and edition to 2024 2025-03-15 14:15:45 +01:00
Christian Visintin 8a9ba7745a Merge pull request #325 from eggplants/fix-clippy-error
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
fix: clippy error
2025-01-06 12:53:13 +01:00
haruna b7d75a2749 fix: clippy error 2025-01-05 22:52:45 +09:00
Christian Visintin fe0d9b0aa6 Update stale.yml
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
2024-12-28 13:22:03 +01:00
veeso 7dba691ccc fix: isolated-tests for localhost
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2024-11-13 17:06:34 +01:00
veeso 099e2154ba fix: unused import isolated tests 2024-11-13 15:57:49 +01:00
veeso f2efb25ad7 fix: 0.16.1
Install.sh / build (push) Waiting to run
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
2024-11-12 12:34:26 +01:00
veeso e45c3d5b4e fix: gg rust 1.82 for introducing a nice breaking change in config which was not mentioned in changelog
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2024-10-21 11:09:50 +02:00
veeso 69f821baef fix: cfg unix forbidden in rust .82
Install.sh / build (push) Waiting to run
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
2024-10-21 10:32:50 +02:00
Christian Visintin 11559d0962 Merge pull request #302 from veeso/0.16
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
0.16
2024-10-14 16:36:36 +02:00
veeso 79c33095fc fix: tiny ui issue 2024-10-14 16:00:15 +02:00
veeso 0ec6bcbcef fix: 0.16
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Linux / build (push) Has been cancelled
2024-10-14 11:40:45 +02:00
Christian Visintin 3cde067339 feat: Show .. directory before all the others in the explorer to navigate to the parent dir (#301) 2024-10-14 11:28:02 +02:00
Christian Visintin c05ef32270 fix: issue 292 New version alert was not displayed due to a semver regex issue. (#300) 2024-10-14 10:43:47 +02:00
Christian Visintin 7eb913ec7b fix: tuirealm 2.x (#299) 2024-10-14 09:55:52 +02:00
veeso 4e63093d25 fix: users from lock
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2024-10-07 17:50:15 +02:00
Christian Visintin e5d50698d2 fix: vergen (#296) 2024-10-07 17:49:52 +02:00
Christian Visintin 79c31c2d84 fix: Use uzers instead of the dead package users which has several vulnerabilities (#295) 2024-10-07 17:40:35 +02:00
Christian Visintin aab266a661 285 feature request multi host (#293) 2024-10-07 16:27:45 +02:00
veeso a4c9acb49f feat: version 0.16 2024-10-05 17:41:40 +02:00
veeso 6205c7f3c5 fix: include build.rs
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2024-10-03 17:57:49 +02:00
veeso e4af014013 fix: readme 2024-10-03 17:56:51 +02:00
Christian Visintin c9f649f40f Merge pull request #288 from veeso/0.15 2024-10-03 17:55:50 +02:00
veeso 1f27ca2607 fix: ci 2024-10-03 17:36:44 +02:00
veeso a1288c7480 fix: github ci is stable and reliable (one worker broken each 2 weeks) 2024-10-03 17:28:29 +02:00
veeso 4bfec52ba5 fix: set date 2024-10-03 17:12:45 +02:00
Christian Visintin 3f01be3baa 280 feature request go to path auto completion (#287) 2024-10-03 17:11:25 +02:00
Christian Visintin 8e2ffeabce fix: 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
2024-10-03 12:17:03 +02:00
Christian Visintin fc68e2621b feat: it is now possible to cancel find command; show find progress (#284) 2024-10-03 11:31:16 +02:00
Christian Visintin b2a8a3041c 249 feature request better search results (#282)
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
* feat: issue 249 - fuzzy search replaced the old find explorer

* fix: forgot to upload file

* fix: removed debug
2024-10-02 17:45:48 +02:00
veeso c507d54700 fix: popup texts
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
2024-10-02 12:59:53 +02:00
veeso 31c5ad7534 fix: issue 277 Fix a bug in the configuration page, which caused being stuck if the added SSH key was empty 2024-10-02 12:44:35 +02:00
veeso 14ac10547c fix: don't clear screen after terminating termscp 2024-10-02 12:34:00 +02:00
Christian Visintin ae1638ee17 feat: Pods and container explorer for Kube protocol (#281) 2024-10-02 12:24:46 +02:00
veeso c5f76ec51c fix: bump vers 2024-10-02 10:33:42 +02:00
veeso d319a2fae4 fix: notify 6 2024-10-02 10:25:30 +02:00
veeso 72a5703a08 fix: keyring test not passing macos 2024-10-02 10:09:09 +02:00
veeso 91b4d4e463 fix: bump vers 2024-09-30 12:06:42 +02:00
veeso 17719ea370 feat: init 0.15 2024-09-30 12:06:03 +02:00
veeso 707a3faa54 fix: dbus deveL
Coverage / build (push) Has been cancelled
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2024-08-06 09:26:49 +02:00
veeso dfe58e6147 fix: tokio rt builder
Coverage / build (push) Has been cancelled
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2024-07-22 10:36:16 +02:00
veeso c49dab3888 fix: changelog
Coverage / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Install.sh / build (push) Has been cancelled
2024-07-17 17:05:15 +02:00
veeso 47ff07e496 feat: termscp 0.14 2024-07-17 16:22:53 +02:00
veeso 61a8fb95e4 fix: removed support for RPM 2024-07-17 12:41:49 +02:00
Christian Visintin f757336d75 feat: kube protocol support (#267) 2024-07-17 11:59:30 +02:00
veeso cf529c1678 fix: german manual
Coverage / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
Linux / build (push) Has been cancelled
2024-07-15 15:20:29 +02:00
Christian Visintin 631f09b9a8 feat: issue 256 - filter files (#266) 2024-07-15 15:08:22 +02:00
Eric Long 65aed76605 chore: bump ring to 0.17 (#265) 2024-07-15 11:52:55 +02:00
veeso 9036d83635 fix: remotefs-ssh 0.3.1
Coverage / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
Windows / build (push) Has been cancelled
2024-07-09 12:25:47 +02:00
Christian Visintin 179c4de4ed feat: ssh-agent (#264) 2024-07-09 11:55:17 +02:00
Christian Visintin f3b84c97e1 feat: ALT+A to deselect all files (#263)
Coverage / build (push) Waiting to run
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
2024-07-08 15:56:20 +02:00
Christian Visintin b5b3aeb645 fix: Jump to next entry after select (#262) 2024-07-08 15:26:27 +02:00
veeso e5172d4207 fix: sorted flags in readme 2024-07-08 15:24:42 +02:00
Christian Visintin 50e7f5f5d0 fix: CLI remote args cannot handle '@' in the username (#261)
Coverage / build (push) Waiting to run
Linux / build (push) Waiting to run
MacOS / build (push) Waiting to run
Windows / build (push) Waiting to run
2024-07-08 14:57:20 +02:00
veeso 88cdae79a8 fix: lint 2024-07-08 14:48:03 +02:00
Michał Sieroń 4f3b97b198 fix: correct help text for update subcommand (#259)
Windows / build (push) Has been cancelled
Coverage / build (push) Has been cancelled
Install.sh / build (push) Has been cancelled
Linux / build (push) Has been cancelled
MacOS / build (push) Has been cancelled
2024-06-25 22:38:59 +02:00
Hartur Alcantara 54a8317d0e Adding Brazilian Portuguese translation (#253) 2024-05-08 08:52:34 +02:00
Orhun Parmaksız 3a46aa74f9 chore: update tui-rs references to ratatui (#244) 2024-04-18 15:59:31 +02:00
Orhun Parmaksız aca5b37898 docs: update Arch Linux instructions (#243) 2024-04-17 19:26:35 +02:00
veeso 0394a12c9f fix: install script version 2024-03-02 20:42:48 +01:00
Christian Visintin e61d04aa1b Merge pull request #236 from veeso/develop
0.13.0
2024-03-02 20:27:16 +01:00
veeso c0c9f7c0dd fix: lint??? 2024-03-02 19:41:07 +01:00
veeso 905fe5fc9f fix: debian script 2024-03-02 19:36:01 +01:00
veeso 89ab53a71b fix: debian script 2024-03-02 19:35:18 +01:00
veeso 7dccac6105 fix: test 2024-03-02 19:31:36 +01:00
veeso 44051ec718 feat: termscp 0.13.0 2024-03-02 19:28:01 +01:00
Christian Visintin c7469b8594 feat: WebDAV support (#235) 2024-03-02 19:23:27 +01:00
veeso 5dfee2cbd9 fix: AWS S3 wasn't working anymore due to rust-s3 outdate 2024-03-01 17:02:58 +01:00
Christian Visintin 679a829744 233 feature request subcommands (#234) 2024-03-01 10:01:25 +01:00
PIRADATA 2a51ab984c update linux installation command from termscp.veeso.dev/get-started.html (#223) 2023-12-15 18:53:45 +01:00
Jarod 2b2ebadd6a Fixed formatting (#207) 2023-12-15 09:33:55 +01:00
Christian Visintin 2b15a23fe8 Update README.md 2023-11-15 21:50:49 +01:00
veeso d30c3dfadd force tuirealm 1.8 2023-10-06 22:03:08 +02:00
veeso ef8dbb6305 0.12.3 2023-10-06 09:19:03 +02:00
veeso 623ba806e1 0.12.3 2023-10-06 09:17:38 +02:00
veeso ea9dd03f55 Revert "feat: tui-realm 1.9"
This reverts commit cfbecc049d.
2023-10-06 09:13:57 +02:00
veeso 92d20f33fe new site 2023-10-01 16:20:35 +02:00
veeso 15caef83e6 0.12.2 2023-10-01 16:20:04 +02:00
veeso 19992402e2 fix: panic if the terminal screen is too small 2023-10-01 16:18:11 +02:00
veeso 182bbb94a2 0.12.2 2023-10-01 16:12:47 +02:00
Christian Visintin 20c3e22572 [BUG] - termscp not respecting port in ssh config (#216) 2023-10-01 16:12:43 +02:00
veeso d3c2c084db fix: fmt 2023-08-23 10:11:13 +02:00
veeso cfbecc049d feat: tui-realm 1.9 2023-08-23 09:18:09 +02:00
Christian Visintin 9de171fb83 added cfg smb-windows to be able to disable SMB on windows (#210)
* added cfg smb-windows to be able to disable SMB on windows

* lint
2023-08-20 10:24:34 +02:00
veeso 2f48c765e3 termscp 0.12.0 2023-07-06 16:17:33 +02:00
Christian Visintin ca005cbecd save local file paths in bookmark (#204)
* fix: renamed Bookmark 'directory' to 'remote_path' (keep name in file)

* feat: local_path as file transfer parameter and in bookmark
2023-07-06 16:05:22 +02:00
Christian Visintin ee28d34f29 fix: don't update path breadcrumb if enter/scan dir failed (#203) 2023-07-06 14:55:53 +02:00
veeso 295191b9eb Merge branch 'main' into develop 2023-07-06 11:49:06 +02:00
veeso 16b2aa8596 fix: rustup target 2023-07-06 11:38:38 +02:00
Christian Visintin 522ee0355e feat: build artifacts workflow (#202) 2023-07-06 11:26:14 +02:00
veeso e5ca956897 fix: don't run CI on site/.md change 2023-07-06 11:07:22 +02:00
Christian Visintin a071f3d420 feat: smb is now an optional feature (#200) 2023-07-06 11:02:53 +02:00
veeso 66888c418c fix: deps 2023-07-06 09:59:25 +02:00
veeso b5f712fa04 fix: better main runner 2023-07-06 09:49:35 +02:00
529 1509401599 Add missing row in KeybindingsPopup (#193) 2023-07-06 09:17:55 +02:00
veeso 6506f4ae59 fixed theme 2023-07-05 13:22:56 +02:00
veeso 5a5fa52b57 fixed theme 2023-07-05 12:58:21 +02:00
veeso b7d4c68ebe new termscp site 2023-07-05 12:33:17 +02:00
Renan Dorneles Schuquel 00a6c53178 Fix: Some URL typos on 'install.sh' and 'README.md'. (#197)
Co-authored-by: rschuquel <renan.schuquel@unimedvtrp.com.br>
2023-06-23 21:54:38 +02:00
Christian Visintin 67bc1a2a08 Ignore backlog issues 2023-05-23 09:20:11 +02:00
Christian Visintin 0bb3c9a26e Create stale.yml 2023-05-22 23:22:57 +02:00
veeso 4394941c71 fix: readme site links 2023-05-20 15:01:22 +02:00
veeso 175ea23bfc fix: sh compliant macos.sh build script 2023-05-18 11:53:21 +02:00
veeso cef100e5d9 fix: install workflow 2023-05-18 11:42:24 +02:00
veeso afba6c32c5 fix: release date 2023-05-16 15:52:50 +02:00
veeso 31f5bd095b fix: macos script 2023-05-16 14:38:16 +02:00
veeso e1add0ed28 fix: pavao 0.2.3 2023-05-16 09:29:57 +02:00
veeso 79bc6a684b fix: pavao 0.2.2 2023-05-16 09:27:48 +02:00
veeso bae4db8e27 fix: build 2023-05-15 14:23:13 +02:00
veeso 4cbba3f3cb fix: release date 2023-05-13 18:11:07 +02:00
veeso e9fbb7f317 fix: specify ssh2 config params 2023-05-13 17:59:24 +02:00
Christian Visintin 044f2436f8 Don't prompt for password if a ssh key is set for that host (#186)
* feat: don't ask password if a ssh key is set for that host

* fix: User from ssh config was not used as it should

* fix: forgot a file
2023-05-13 16:09:37 +02:00
Christian Visintin b7369162d2 SMB support (#184)
* feat: smb client

* fix: smb connection

* fix: smbclient deps

* feat: SMB mentions to user manual

* feat: changelog

* dlib macos

* fix: removed smb support from macos :(

* fix: restored libsmbclient build

* fix: strange lint message

* fix: macos build smb

* fix: macos build smb

* fix: macos tests

* fix: macos lint

* feat: SMB windows support

* fix: windows tests
2023-05-13 15:00:16 +02:00
Christian Visintin a13663e5e9 Brew Linux support (#185)
* feat: brew linux and arm installation

* fix: updated website refs to termscp.veeso.dev

* feat: added brew installation to website
2023-05-12 17:06:27 +02:00
Christian Visintin 79dd9e2303 chmod popup (#183)
* feat: chmod popup

* fix: windows shall not allows chmod on localhost
2023-05-10 17:04:24 +02:00
Christian Visintin b4fa50a666 feat: allow unknown fields in ssh2 configuration file (#181) 2023-05-10 09:27:54 +02:00
Christian Visintin 5a67fc7b0e fix: #153 show a loading message when loading directory's content (#180) 2023-05-09 17:43:37 +02:00
veeso 9dab34e7ee rustfmt.toml 2023-05-09 15:40:28 +02:00
veeso c5eeae74b7 fmt 2023-05-09 15:40:21 +02:00
Christian Visintin 9009002b6e debug log belongs in cache directory not config directory (#179)
* log files are now written to cache dir instead of config dir

* lint

* fmt
2023-05-09 15:32:42 +02:00
veeso 9bf23b3f6b working on 0.12 2023-05-09 12:48:51 +02:00
veeso 3ec94c17bc 0.11.3 2023-04-19 11:07:42 +02:00
veeso ed8ba628e5 feat: site improvements 2023-04-19 11:01:44 +02:00
veeso 7c638473d6 0.11.3 2023-04-19 10:17:59 +02:00
Christian Visintin d37140ead6 fix: relative paths windows (#167) 2023-04-19 10:15:00 +02:00
veeso fdb0d97a61 rtd 2023-04-18 18:10:40 +02:00
veeso 0c1e9c0d60 feat: site 0.11.2 2023-04-18 11:59:13 +02:00
veeso e1a2255a58 feat: dependencies up-to-date 2023-04-18 11:58:10 +02:00
Christian Visintin f6b2c814c0 bump remotefs-ssh to 0.1.5 (#164) 2023-04-18 11:44:49 +02:00
delta2force efb30231ee update Cargo.lock (#157) 2023-03-23 14:05:12 +01:00
veeso 8cb6c19210 updated curl 2023-03-08 12:07:25 +01:00
veeso 51c2618b5a optimized docker builds (re-use containers) 2023-03-08 11:49:09 +01:00
veeso 279df59b5d install ci 2023-03-07 21:01:29 +01:00
veeso d8373d0eba 0.11.1 2023-03-07 09:31:21 +01:00
veeso 74fe97f2e2 Don't tell me you're too blind to see 2023-03-06 11:16:40 +01:00
veeso e62f15f375 gb.png 2023-03-06 11:15:44 +01:00
veeso 21dc73b556 Bump ssh2-config to 0.1.6 2023-03-03 12:13:19 +01:00
veeso a10325f6fb removed remove_dir_all crate with tempfile 3.4 2023-02-28 11:09:57 +01:00
Christian Visintin 1ecef6fc16 issue 150: some issues with configuration (#151)
* issue 150: some issues with configuration
2023-02-28 10:45:07 +01:00
veeso 67df3dc76a working on 0.11.1 2023-02-27 12:23:01 +01:00
Christian Visintin 7ecfaea278 Update FUNDING.yml 2023-02-27 11:50:21 +01:00
veeso 97151d18bf fixed build scripts 2023-02-22 16:06:11 +01:00
veeso 7ad7a1580d fixed serializer 2023-02-19 18:46:10 +01:00
veeso 46f2954bc4 install.yml 2023-02-19 18:24:29 +01:00
veeso 0c88f559e2 0.11.0 2023-02-19 18:23:30 +01:00
veeso 8a0979578a deps 2023-02-13 09:35:10 +01:00
veeso 7ee28a00ae planned updates 2023-02-12 22:28:43 +01:00
Christian Visintin 82330f870e Optimize transfers (#147)
* When the file is exchanged, all times attributes are set (if supported by the protocol)

* If local/remote file have the same last modification time (`mtime`), the file is not transferred
2023-02-12 22:27:42 +01:00
veeso 54aecdc478 0.11.0 2023-02-11 12:49:30 +01:00
veeso d5038a22ee fixed tests 2023-02-11 12:45:12 +01:00
Christian Visintin c0bc493d21 125 installation missing aarch64 linux build (#146)
aarch64 build
2023-02-11 12:26:43 +01:00
Christian Visintin 1c75c7d386 SSH configuration path is not ~/.ssh/config by default (#145)
SSH configuration path is not `~/.ssh/config` by default
2023-02-11 12:23:57 +01:00
Christian Visintin 251b125cbb 126 new feature termscp doesnt use id rsa default ssh private key to authenticate to sftp scp endpoint (#144)
fixed issue 126 <https://github.com/veeso/termcp/issues/126>
2023-02-11 12:23:56 +01:00
veeso efd2235ff3 fmt 2023-02-11 12:23:56 +01:00
veeso 1db2ff7ec5 Popup with fixed sizes or percentage 2023-02-11 12:23:56 +01:00
veeso 4d5f3a6b63 lint 2023-02-11 12:23:56 +01:00
veeso 62003308a7 lint 2023-02-11 12:23:56 +01:00
veeso cb037cfca9 updated dependencies 2023-02-11 12:23:56 +01:00
Sergei Akhmatdinov 15fffdf0c9 fix install script for FreeBSD, add doas priv elevation 2023-01-31 15:03:07 +01:00
veeso c1b245b4c9 fixed install script for freebsd 2023-01-30 12:15:56 +01:00
veeso d14225c0b9 readme 2023-01-13 09:55:49 +01:00
veeso d60be7dc80 0.10.0 2022-12-28 10:49:36 +01:00
Christian Visintin 146a1f3ed6 Create website.yml 2022-12-27 16:44:42 +01:00
veeso 12fe10100b termscp site 2022-12-27 16:42:25 +01:00
RakerZh 298d590306 fix typo 2022-11-08 09:30:48 +01:00
pin 8e6aae08b6 Add NetBSD 2022-10-25 18:10:00 +02:00
veeso cb33ba114e fixed check on aarch64 2022-10-25 18:09:06 +02:00
veeso 6369ead491 Merge branch '0.10.0' into main 2022-10-15 14:01:40 +02:00
veeso ae350b4bfa termscp 0.10 2022-10-15 14:01:00 +02:00
veeso cd5bb28fb7 updated deps 2022-10-10 18:04:44 +02:00
veeso f27a4e2a02 lint 2022-10-10 17:40:03 +02:00
veeso 0f432d0375 fixed build 2022-10-10 17:26:26 +02:00
veeso 8b67c59247 removed deps from docker build 2022-10-10 16:50:00 +02:00
veeso fdd7901f7e removed libssl dependency 2022-10-10 16:21:32 +02:00
Christian Visintin 2eec7c4b2b Update README.md 2022-09-06 12:01:24 +02:00
veeso 64e3848c97 Use ssh2 config IdentityFile as fallback for key based authentication 2022-08-30 17:47:55 +02:00
veeso 833cd7d3ba Fixed version comparison when going above 0.9 2022-08-30 15:54:37 +02:00
veeso 2f1b644a40 backtab will now change the explorer tab; use P to change to log 2022-08-30 15:45:26 +02:00
veeso 6a5c248d35 Yes/No dialogs are now answerable by pressing Y or N on your keyboard 2022-08-30 15:29:34 +02:00
veeso 96df152220 fixed issue 122 <https://github.com/veeso/termscp/issues/122> 2022-08-30 15:10:41 +02:00
veeso a22c5025d7 lint 2022-08-17 10:33:31 +02:00
veeso cce0c92c0b dependencies updated 2022-08-17 10:28:44 +02:00
veeso 90d7083b24 lazy-regex 2022-08-17 10:24:13 +02:00
veeso b3ab76e573 working on 0.10.0 2022-08-17 10:16:03 +02:00
Christian Visintin 66913d5fc1 Update README.md 2022-08-05 14:51:28 +02:00
veeso f5174ccac0 removed dynamic libssl dep 2022-07-20 12:37:22 +02:00
veeso 82489e7459 homebrew notice 2022-07-20 12:08:11 +02:00
eric wong ad562a7b09 Optimize the presentation of zh-CN/README.md (#117) 2022-07-18 09:31:31 +02:00
veeso 08c42e5acf release date 2022-06-18 13:35:03 +02:00
veeso aac9cf4fa0 features updated 2022-06-10 12:18:38 +02:00
veeso a26b21da89 0.9.0 2022-06-09 17:45:17 +02:00
veeso bb95c9a4d0 updated dependencies 2022-06-09 15:11:55 +02:00
veeso 80dea3f71a Fixed SSH key list showing {hostname} at {username} instead of {username} at {hostname} 2022-06-09 15:08:02 +02:00
veeso 0057a657d2 removed license headers 2022-06-09 14:28:02 +02:00
Christian Visintin 816270d545 Fs watcher (#113)
fs watcher
2022-06-09 13:03:02 +02:00
veeso 2caa0432df Remote directory path in authentication form and in bookmarks parameters 2022-05-03 15:37:00 +02:00
Christian Visintin e0d8b80cdf Bookmark name as hostname for cli args (#111)
bookmark name as hostname for cli args
2022-05-03 11:54:48 +02:00
veeso f094979ddb working on 0.9.0 2022-05-03 09:16:38 +02:00
veeso 0c8144aaa8 0.8.2 2022-04-26 21:41:21 +02:00
veeso 3249e82873 lint 2022-04-22 09:56:10 +02:00
veeso 66adad3135 Fixed termscp panics when displaying long non-ascii filenames 2022-04-20 12:09:33 +02:00
veeso f2e5bf4441 Working on 0.8.2 2022-04-07 11:08:47 +02:00
veeso 601b0595d4 Write exitcode on exit 2022-04-07 11:07:41 +02:00
veeso c47fcb2225 fixed install script 2022-04-07 10:24:54 +02:00
veeso 550c7ca62a upcoming features 2022-03-22 20:55:54 +01:00
veeso 3256c276b4 0.8.1 2022-03-22 20:45:24 +01:00
veeso 04f43fff63 boolean release 2022-03-19 10:35:36 +01:00
veeso 82e8c84000 fixed make_pkg 2022-03-15 12:22:43 +01:00
veeso 31203d76ce install.sh m1 macos 2022-03-15 11:25:50 +01:00
veeso 572a948f2c macos arm64 build 2022-03-15 11:25:50 +01:00
veeso b6ee49cfa6 updated donation link in install.sh 2022-03-09 17:07:35 +01:00
veeso 0334c5db78 Updated dependencies 2022-03-09 16:19:57 +01:00
veeso c45ebec261 Fixed AltGr characters not allowed in auth form 2022-03-09 15:13:08 +01:00
veeso ad2781b62c use latest rust in macos/windows ci 2022-03-09 11:27:26 +01:00
veeso 35dc11cce3 Strip binary with new 1.59 feature 2022-03-05 11:11:07 +01:00
veeso 8d9e7443ec updated user manuals 2022-03-05 11:06:14 +01:00
veeso 697ab225ea clippy 2022-03-05 11:06:14 +01:00
veeso babbc5eadb new-path-style and endpoint s3 params 2022-03-05 11:06:14 +01:00
veeso f28dba7660 added new s3 params 2022-03-05 11:06:14 +01:00
veeso c5eba4b56a changed 'AWS S3' to 'S3' in forms 2022-03-05 11:06:14 +01:00
veeso 0b70819781 wtf git? 2022-02-06 11:09:44 +01:00
veeso 069fe8cae2 Merge branch '0.8.1' of github.com:veeso/termscp into 0.8.1 2022-02-06 10:57:44 +01:00
veeso 043f54e707 removed freebsd workflow. It is not supported anymore 2022-02-06 10:57:27 +01:00
veeso b635554e52 updated freebsd vm version 2022-02-04 15:16:07 +01:00
veeso 9e35616568 updated dependencies 2022-02-04 15:14:11 +01:00
veeso 615dbda583 clippy 2022-02-04 15:06:11 +01:00
veeso 4b421a4a87 issue 94: color not reset after leaving text editor (SORCERY!!!) 2022-01-29 19:26:37 +01:00
veeso 0fe06eb52b updated deps 2022-01-29 19:04:22 +01:00
veeso e8c6b8306f working on 0.8.1 2022-01-29 19:03:12 +01:00
Pascal Sommer d1457253c4 fix: footer listed "Delete" shortcut as "Make Dir" 2022-01-12 21:03:15 +01:00
ImgBotApp 1bcdaa5614 [ImgBot] Optimize images
*Total -- 1,968.08kb -> 1,553.38kb (21.07%)

/assets/images/termscp-96.png -- 4.01kb -> 2.78kb (30.66%)
/assets/images/termscp-128.png -- 5.41kb -> 3.75kb (30.66%)
/assets/images/termscp-512.png -- 24.29kb -> 16.96kb (30.17%)
/assets/images/termscp-64.png -- 2.77kb -> 1.96kb (29.32%)
/assets/images/config.gif -- 1,246.97kb -> 937.11kb (24.85%)
/assets/images/auth.gif -- 420.79kb -> 335.62kb (20.24%)
/assets/images/flags/jp.png -- 7.43kb -> 6.19kb (16.64%)
/assets/images/flags/cn.png -- 6.80kb -> 5.78kb (15.07%)
/assets/images/flags/br.png -- 10.83kb -> 9.35kb (13.67%)
/assets/images/flags/kr.png -- 10.04kb -> 8.72kb (13.17%)
/assets/images/termscp.svg -- 1.39kb -> 1.25kb (10.08%)
/assets/images/themes.gif -- 227.34kb -> 223.90kb (1.52%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
2022-01-06 11:15:26 +01:00
veeso 85dd67721f new gifs 2022-01-06 11:07:29 +01:00
veeso a25ee67cd3 use branch in docker build 2022-01-06 10:44:34 +01:00
veeso 67d48e7a79 readme 2022-01-06 10:44:34 +01:00
veeso 49e69277af Updated deps 2022-01-06 10:44:34 +01:00
veeso 332284fec3 keyring 1.0.0 2022-01-06 10:44:34 +01:00
veeso 4897253932 2022-01-05 review 2022-01-06 10:44:34 +01:00
veeso 6559c6b083 Error popup message height is now calculated based on the content it must display 2022-01-06 10:44:34 +01:00
veeso 587d7da2cb re-use code with handle input ev 2022-01-06 10:44:34 +01:00
Christian Visintin 7d55563556 Aws s3 connection parameters extension (#89)
* Aws s3 connection parameters extension

* Changed 'save password?' popup to 'change secrets?'

* missing docs
2022-01-06 10:44:34 +01:00
veeso 53271966da Changed buffer size to 65535 2022-01-06 10:44:34 +01:00
veeso ec4daf8e25 remotefs 0.2.0 2022-01-06 10:44:34 +01:00
veeso edd0842273 Redraw UI on window resize 2022-01-06 10:44:34 +01:00
veeso c1edc20462 symlink command 2022-01-06 10:44:34 +01:00
veeso ced7573241 symlink command 2022-01-06 10:44:34 +01:00
veeso 24788fa894 remove temp archive once installation has finished 2022-01-06 10:44:34 +01:00
veeso dab98f4292 F2 to save file as 2022-01-06 10:44:34 +01:00
veeso 84cb775679 Categorize Auth activity msg 2022-01-06 10:44:34 +01:00
veeso 4e802f1dc5 Use tui-realm color parser 2022-01-06 10:44:34 +01:00
veeso b8efe6985f Removed storage key for filetransfer terminal width 2022-01-06 10:44:34 +01:00
veeso e047179ea0 Remove pending transfer with storage (use action) 2022-01-06 10:44:34 +01:00
veeso 197b3095b6 Disable sync browsing when found explorer is mounted 2022-01-06 10:44:34 +01:00
Christian Visintin 54c23079be Sync browsing prompts to create dir (#85) 2022-01-06 10:44:34 +01:00
veeso a93dbde0c8 Added help footers 2022-01-06 10:44:34 +01:00
veeso 2a3d4f2670 Default log level changed to INFO; added option to enable TRACE log level 2022-01-06 10:44:34 +01:00
Christian Visintin e6ba4d8430 SSH configuration path (#84)
SSH configuration
2022-01-06 10:44:34 +01:00
veeso 9284f101c8 mode 2022-01-06 10:44:34 +01:00
veeso 685444655c Ux improvements (described in issue #80) 2022-01-06 10:44:34 +01:00
veeso 027545f14c Removed docs headers 2022-01-06 10:44:34 +01:00
veeso 2e0322bc0e dir size is 0 on Windows 2022-01-06 10:44:34 +01:00
veeso df7a4381c4 Removed filetransfer module; migrated to remotefs crate 2022-01-06 10:44:34 +01:00
veeso 25dd1b9b0a updated donation link in help 2022-01-06 10:44:34 +01:00
veeso a1a1631fd2 Removed unused focus, fixed partial prog bar alignment 2022-01-06 10:44:34 +01:00
veeso 47f3ffef7b Removed key modifiers none on popups, since on windows they won't work 2022-01-06 10:44:34 +01:00
veeso 54b5583d1a Migrated termscp to tui-realm 1.x 2022-01-06 10:44:34 +01:00
veeso 30851a78e8 serial test for env paths 2022-01-06 10:44:34 +01:00
veeso bc6b7b582e Files found from search are now displayed with their relative path from working directory 2022-01-06 10:44:34 +01:00
veeso 3927fb2a39 Files found from search are now displayed with their absolute path 2022-01-06 10:44:34 +01:00
veeso 028f64a588 Windows opts 2022-01-06 10:44:34 +01:00
veeso 26ff496829 It is now possible to keep navigating on the other explorer while 'found tab' is open 2022-01-06 10:44:34 +01:00
veeso cb583f305c If find command doesn't return any result show an info dialog and not an empty explorer 2022-01-06 10:44:34 +01:00
veeso 88b29d3183 A "wait popup" will now be displayed while searching files 2022-01-06 10:44:34 +01:00
veeso 02fdb27cc5 Removed lib.rs 2022-01-06 10:44:34 +01:00
veeso 5fd53c1b2b -Dwarnings for clippy on windows/macos ci 2022-01-06 10:44:34 +01:00
veeso 696e3ae582 Rust 2021 2022-01-06 10:44:34 +01:00
veeso e7a29b7f1a 0.8.0 setup 2022-01-06 10:44:34 +01:00
veeso e53120f3c2 arch: install rust only if not found on local system 2021-12-21 09:05:34 +01:00
veeso 3f463f4b73 ko-fi 2021-12-04 10:46:22 +01:00
veeso 83964026ec new donations banners 2021-10-30 15:54:02 +02:00
veeso f79658a93c new donations banners 2021-10-30 15:49:35 +02:00
veeso 23fd37559e Fixed install script 2021-10-12 10:54:33 +02:00
veeso 1fadc53743 Merge branch 'main' of github.com:veeso/termscp into main 2021-10-12 10:54:18 +02:00
veeso 0eaa898e15 Fixed docker.sh 2021-10-12 09:09:57 +02:00
veeso 0aeca76f63 Fixed bash 2021-10-11 20:40:20 +02:00
veeso 8cf6c1fce3 freebsd pkg 2021-10-11 09:30:21 +02:00
veeso 736dd820a6 donate links 2021-10-10 09:52:49 +02:00
veeso db73d1e45f gitignore 2021-10-09 10:58:38 +02:00
veeso 6c31c1f2d8 deb readme 2021-10-09 10:55:21 +02:00
veeso fcce9b778b typos 2021-10-09 10:47:07 +02:00
veeso b309a55ed6 Merge branch 'md-translations' into 0.7.0 2021-10-07 11:22:14 +02:00
veeso 8b2b834818 User manuals 2021-10-07 09:37:34 +02:00
veeso 9a63f5b2cc copy template 2021-10-06 11:12:15 +02:00
veeso a7a116cb33 Badges aligned 2021-10-06 10:38:57 +02:00
veeso bc90fb1038 Align badges 2021-10-06 10:38:03 +02:00
veeso e307b6a8ac Align badges 2021-10-06 10:37:36 +02:00
veeso c9e8589689 readmes 2021-10-06 10:30:24 +02:00
veeso e09682c219 wip 2021-10-06 08:45:02 +02:00
Christian Visintin 967babbcb7 Merge pull request #71 from veeso/issue-70-cant-enter-@-in-password-input-box
Issue 70 cant enter @ in password input box
2021-10-04 21:03:58 +02:00
veeso 4973bf8cbe Fixed issue 70: Unable to type characters with CTRL+ALT 2021-10-04 21:03:17 +02:00
veeso 6421b74c66 typo 2021-10-04 17:50:07 +02:00
veeso 463329a080 docs url 2021-10-04 16:11:45 +02:00
veeso fd2144f8e9 It, zh-CN 2021-10-04 16:02:40 +02:00
veeso 18a579a204 Flags 2021-10-04 10:48:56 +02:00
veeso 58d5ea264f docs 2021-09-30 09:56:20 +02:00
veeso 4b9d23cc3a Reuse mounts 2021-09-30 09:33:34 +02:00
veeso f3e694d3d6 File list can now be rewinded 2021-09-28 12:59:43 +02:00
Christian Visintin b9a0e516c6 Merge pull request #68 from veeso/notifications
Notifications
2021-09-28 12:58:11 +02:00
veeso 198d421ab0 Notifications 2021-09-28 12:44:51 +02:00
veeso 6caf34b17a Added dbus to deps for FreeBSD 2021-09-27 22:38:08 +02:00
veeso f0a91b1579 Merge remote-tracking branch 'origin/main' into 0.7.0 2021-09-27 11:48:36 +02:00
veeso c3e5663cf4 New logo 2021-09-27 11:48:22 +02:00
veeso bcc6fcd2e7 Added file replace prompt also for 'Many' 2021-09-25 20:18:50 +02:00
veeso 3c3d681ca0 Updated chinese manual 2021-09-25 14:29:48 +02:00
veeso 3e83c26cd5 Merge branch 'main' into 0.7.0 2021-09-25 13:59:58 +02:00
veeso ec841d5382 Some flags are controversial :rolling_eyes 2021-09-25 13:58:27 +02:00
veeso d2e4252487 there's no need to specify language 2021-09-25 13:57:24 +02:00
veeso 7660dad4eb man-en 2021-09-25 13:56:40 +02:00
Christian Visintin ddfa973c19 Merge pull request #67 from flashlab/main
Translate doc into simplified Chinese
2021-09-25 11:16:47 +02:00
Jeff def0eb8586 small fix to the image path 2021-09-25 14:20:19 +08:00
flashlab c39ee82ac5 translate doc into simplified Chinese 2021-09-25 14:10:46 +08:00
Christian Visintin e1bde1971d Merge pull request #65 from veeso/prompt-when-replacing-files
Prompt user when about to replace an existing file
2021-09-24 09:22:50 +02:00
veeso 79c90c5b97 install with cargo --locked 2021-09-19 15:02:14 +02:00
veeso 06ffbaa2f4 Option: prompt user when about to replace an existing file caused by a file transfer 2021-09-19 11:18:52 +02:00
veeso 63e7023342 Re-use mounts in UI 2021-09-19 11:16:18 +02:00
veeso 88a0685097 Added misc_info_dialog to themes 2021-09-19 10:48:16 +02:00
veeso ed3225ed84 User manual updates 2021-09-18 22:07:59 +02:00
veeso 96c997c38a dirs 4.0.0 2021-09-18 14:22:00 +02:00
veeso c824d00986 Removed auto-update test for macos (blocks on github/CI) 2021-09-17 09:52:35 +02:00
veeso c052796d52 Merge remote-tracking branch 'origin/main' into 0.7.0 2021-09-16 17:07:13 +02:00
Christian Visintin 1077204965 Merge pull request #64 from veeso/self-update
Self update
2021-09-16 17:05:07 +02:00
veeso 77476596f4 Fixed new version check 2021-09-16 16:54:43 +02:00
Christian Visintin efd5443be4 choco install 2021-09-16 09:30:19 +02:00
veeso 8c88fbe10f cargo lock update 2021-09-12 10:01:52 +02:00
veeso 06a67de14f Auto update (w/ cli) 2021-09-12 10:00:56 +02:00
veeso 8bb05406c8 upcoming features 2021-09-11 22:06:18 +02:00
veeso 3f31800158 Updated dependencies 2021-09-11 21:53:38 +02:00
veeso f69489fc8f FileTransferResult 2021-09-10 20:58:26 +02:00
veeso 1f115dea92 Strip executables when making release 2021-09-10 20:51:05 +02:00
Christian Visintin f81424f1db Merge pull request #63 from veeso/aws-s3
Aws s3
2021-09-10 17:32:28 +02:00
veeso 1d09095ab9 Aws s3 support 2021-09-01 15:20:05 +02:00
Christian Visintin bf6f25310c Update README.md 2021-08-31 16:24:26 +02:00
veeso f31f58aa79 working on 0.7.0 2021-08-26 10:42:46 +02:00
401 changed files with 63350 additions and 24185 deletions
+44
View File
@@ -0,0 +1,44 @@
#!/usr/bin/env bash
#
# termscp pre-commit hook.
#
# Runs two gates before a commit is recorded:
# 1. dprint -- check formatting (Markdown, TOML, YAML, Rust)
# 2. cargo-deny -- advisories, licenses, bans, and sources
#
# Install with `just setup_githooks` (sets core.hooksPath to .githooks).
# Bypass in an emergency with `git commit --no-verify`.
set -euo pipefail
fail() {
echo "pre-commit: $1" >&2
exit 1
}
command -v just >/dev/null 2>&1 || fail "just not found; install it to run the pre-commit checks"
if ! git diff --cached --quiet --diff-filter=ACMR --; then
# Check the exact tree that will be committed, not possibly different
# working-tree contents. The trailing slash is required by checkout-index.
index_tree="$(mktemp -d)"
cleanup() {
rm -rf -- "$index_tree"
}
trap cleanup EXIT
git checkout-index --all --prefix="$index_tree/"
echo "pre-commit: checking staged-tree formatting"
(
cd "$index_tree"
just fmt_check
)
echo "pre-commit: checking staged-tree dependencies"
(
cd "$index_tree"
just deny
)
fi
echo "pre-commit: all checks passed"
+4 -1
View File
@@ -1 +1,4 @@
custom: ['https://www.buymeacoffee.com/veeso']
# These are supported funding model platforms
github: veeso
liberapay: veeso
-1
View File
@@ -4,7 +4,6 @@ about: Create a report of the bug you've encountered
title: "[BUG] - ISSUE_TITLE"
labels: bug
assignees: veeso
---
## Description
+34
View File
@@ -0,0 +1,34 @@
---
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
@@ -4,7 +4,6 @@ about: Suggest an idea to improve termscp
title: "[Feature Request] - FEATURE_TITLE"
labels: "new feature"
assignees: veeso
---
## Description
-1
View File
@@ -4,5 +4,4 @@ about: Ask what you want about the project
title: "[QUESTION] - TITLE"
labels: question
assignees: veeso
---
-1
View File
@@ -4,7 +4,6 @@ about: Create a report of a security vulnerability
title: "[SECURITY] - ISSUE_TITLE"
labels: security
assignees: veeso
---
## Description
+9 -34
View File
@@ -1,40 +1,15 @@
# ISSUE _NUMBER_ - PULL_REQUEST_TITLE
# Description
Fixes # (issue)
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
List here your changes
- I made this...
- I made also that...
## Type of change
Please select relevant options.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
<!--
Provide a brief description of the changes you made in this pull request. If your changes are related to a specific issue, please mention the issue number (e.g., "Fixes #123").
-->
## Checklist
- [ ] 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
- [ ] 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
- [ ] 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
- [ ] I have read the [AI Policy](https://github.com/veeso/termscp/blob/main/AI_POLICY.md) and the [contributing guidelines](https://github.com/veeso/termscp/blob/main/CONTRIBUTING.md).
## Acceptance tests
## AI Disclosure
wait for a *project maintainer* to fulfill this section...
- [ ] regression test: ...
<!--
Describe how you used AI tools in this contribution. If you did not use any AI tools, write "N/A".
-->
+2 -1
View File
@@ -7,9 +7,10 @@ ignore:
- "C:/*"
- "../*"
- src/main.rs
- src/lib.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
+138
View File
@@ -0,0 +1,138 @@
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:
toolchain:
runs-on: ubuntu-latest
outputs:
channel: ${{ steps.extract.outputs.result }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Extract toolchain channel from rust-toolchain.toml
id: extract
uses: mikefarah/yq@c14f446382944492701b16c1ddb48bb9dbe683e3 # v4.53.6
with:
cmd: yq '.toolchain.channel' rust-toolchain.toml
fmt:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install Rust (nightly)
uses: dtolnay/rust-toolchain@4360b52568e2003a75bf9bc1d59f33a8e3fc893c # stable
with:
toolchain: nightly
components: rustfmt
- name: Check formatting
uses: dprint/check@9cb3a2b17a8e606d37aae341e49df3654933fc23 # v2.3
install-scripts:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- name: Check install scripts
run: just check_install_scripts
crates:
needs: toolchain
name: crates-${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install Linux dependencies
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get 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 Rust
uses: dtolnay/rust-toolchain@4360b52568e2003a75bf9bc1d59f33a8e3fc893c # stable
with:
toolchain: ${{ needs.toolchain.outputs.channel }}
components: clippy
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- name: Build
run: just build_crates
- name: Test (Linux)
if: runner.os == 'Linux'
run: just test "--no-default-features --features github-actions --no-fail-fast"
- name: Test
if: runner.os != 'Linux'
run: just test "--verbose --features github-actions"
- name: Clippy
run: just clippy "-- -D warnings"
doc:
needs: toolchain
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install Linux dependencies
run: sudo apt-get update && sudo apt-get install -y libdbus-1-dev libsmbclient-dev
- name: Install Rust
uses: dtolnay/rust-toolchain@4360b52568e2003a75bf9bc1d59f33a8e3fc893c # stable
with:
toolchain: ${{ needs.toolchain.outputs.channel }}
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- name: Build documentation
run: just doc
deny:
needs: toolchain
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install Rust
uses: dtolnay/rust-toolchain@4360b52568e2003a75bf9bc1d59f33a8e3fc893c # stable
with:
toolchain: ${{ needs.toolchain.outputs.channel }}
- name: Install cargo-deny
uses: taiki-e/install-action@37f7c5781271959fb65b6b35224e28652ff2b63d # v2.87.0
with:
tool: cargo-deny
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- name: Check dependencies
run: just deny
-37
View File
@@ -1,37 +0,0 @@
name: Coverage
on: [push, pull_request]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup containers
run: docker-compose -f "tests/docker-compose.yml" up -d --build
- name: Setup nightly toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true
- name: Run tests (nightly)
uses: actions-rs/cargo@v1
with:
command: test
args: --lib --no-default-features --features github-actions --features with-containers --no-fail-fast
env:
CARGO_INCREMENTAL: "0"
RUSTFLAGS: "-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests"
RUSTDOCFLAGS: "-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests"
- name: Coverage with grcov
id: coverage
uses: actions-rs/grcov@v0.1
- name: Coveralls
uses: coverallsapp/github-action@v1.1.1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
path-to-lcov: ${{ steps.coverage.outputs.report }}
-22
View File
@@ -1,22 +0,0 @@
name: FreeBSD
on: [push, pull_request]
jobs:
build:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: FreeBSD build
id: test
uses: vmactions/freebsd-vm@v0.1.4
with:
usesh: true
prepare: pkg install -y curl wget libssh gcc vim
run: |
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > /tmp/rustup.sh && \
chmod +x /tmp/rustup.sh && \
/tmp/rustup.sh -y
. $HOME/.cargo/env
cargo build --no-default-features
cargo test --no-default-features --verbose --lib --features github-actions -- --test-threads 1
+32
View File
@@ -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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Install termscp from script
run: |
./install.sh -f
which termscp || exit 1
termscp --version
-29
View File
@@ -1,29 +0,0 @@
name: Linux
on: [push, pull_request]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup containers
run: docker-compose -f "tests/docker-compose.yml" up -d --build
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
components: rustfmt, clippy
- name: Run tests
uses: actions-rs/cargo@v1
with:
command: test
args: --lib --no-default-features --features github-actions --features with-containers --no-fail-fast
- name: Format
run: cargo fmt --all -- --check
- name: Clippy
run: cargo clippy -- -Dwarnings
-19
View File
@@ -1,19 +0,0 @@
name: MacOS
on: [push, pull_request]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Build
run: cargo build
- name: Run tests
run: cargo test --verbose --lib --features github-actions -- --test-threads 1
- name: Clippy
run: cargo clippy
+66
View File
@@ -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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
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@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: site_out
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
+475
View File
@@ -0,0 +1,475 @@
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 }}
prepared_ref: ${{ steps.prepared-ref.outputs.ref }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
token: ${{ secrets.RELEASE_PAT }}
persist-credentials: true
fetch-depth: 0
fetch-tags: true
- name: Validate version
env:
VERSION: ${{ inputs.version }}
run: |
if [[ ! "$VERSION" =~ ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$ ]]; then
echo "invalid release version: $VERSION (expected MAJOR.MINOR.PATCH)" >&2
exit 2
fi
- 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@e67fa11c4b9316fa714ddf0abed07a0c3143b95b # v2.87.4
with:
tool: git-cliff,dprint
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- name: Bump version
env:
VERSION: ${{ inputs.version }}
run: dist/release/bump_version.sh "$VERSION" "$(date +%F)"
- name: Generate CHANGELOG
env:
VERSION: ${{ inputs.version }}
run: just changelog "$VERSION"
- name: Generate release notes
env:
VERSION: ${{ inputs.version }}
run: git-cliff --unreleased --tag "v$VERSION" --strip header -o RELEASE_NOTES.md
- name: Verify Cargo.lock is unchanged
run: git diff --exit-code -- Cargo.lock
- name: Upload release notes
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
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 -- . ':!Cargo.lock'
git diff --cached --exit-code -- Cargo.lock
git commit -m "chore: release v$VERSION"
git push origin HEAD:main
- name: Export prepared ref
id: prepared-ref
env:
DRY_RUN: ${{ inputs.dry_run }}
run: |
if [ "$DRY_RUN" = "true" ]; then
echo "ref=$GITHUB_SHA" >> "$GITHUB_OUTPUT"
else
echo "ref=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
fi
build:
needs: prepare
name: build-${{ matrix.target }}
strategy:
fail-fast: false
matrix:
include:
- target: x86_64-unknown-linux-musl
os: ubuntu-24.04
kind: linux
- target: aarch64-unknown-linux-musl
os: ubuntu-24.04-arm
kind: linux
- 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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ needs.prepare.outputs.prepared_ref }}
persist-credentials: false
fetch-depth: 0
fetch-tags: true
- name: Prepare release version
shell: bash
run: |
dist/release/bump_version.sh "$VERSION" "$(date +%F)"
cargo update --package termscp --precise "$VERSION"
cargo metadata --locked --no-deps --format-version 1 > /dev/null
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- name: Install Rust target
if: matrix.kind == 'macos'
run: rustup target add "$TARGET"
- name: Install Rust target
if: matrix.kind == 'windows'
run: rustup target add "$env:TARGET"
# ---- Linux: static musl build in a pinned Alpine container ----
- name: Install cargo-deb (Linux)
if: matrix.kind == 'linux'
run: cargo install cargo-deb --locked
- name: Build (Linux)
if: matrix.kind == 'linux'
run: just build_musl "$TARGET"
- name: Build deb (Linux)
if: matrix.kind == 'linux'
run: cargo deb --locked --no-build --target "$TARGET" --features smb-vendored
- name: Verify deb declares no runtime dependencies (Linux)
if: matrix.kind == 'linux'
run: |
deb=$(ls target/"$TARGET"/debian/*.deb)
depends=$(dpkg-deb -f "$deb" Depends)
if [ -n "$depends" ]; then
echo "static deb must have no Depends, got: $depends" >&2
exit 1
fi
# ---- 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: just build_release "$TARGET" "$FEATURES"
# ---- Windows ----
- name: Build (Windows)
if: matrix.kind == 'windows'
run: just build_release "$env:TARGET" "--features smb-vendored"
# ---- 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@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: build-${{ matrix.target }}
path: artifact/*
retention-days: 1
if-no-files-found: error
publish-homebrew:
needs: [prepare, build, release]
runs-on: ubuntu-latest
env:
VERSION: ${{ needs.prepare.outputs.version }}
steps:
- name: Download build artifacts
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
with:
pattern: build-*
path: dl
merge-multiple: true
- name: Checkout homebrew tap
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
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-musl.sha256)
SHA_LIN_X64=$(cat dl/x86_64-unknown-linux-musl.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/GCS/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
on_arm do
url "$BASE/termscp-v$VERSION-aarch64-unknown-linux-musl.tar.gz"
sha256 "$SHA_LIN_ARM"
end
on_intel do
url "$BASE/termscp-v$VERSION-x86_64-unknown-linux-musl.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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
token: ${{ secrets.RELEASE_PAT }}
ref: ${{ needs.prepare.outputs.prepared_ref }}
persist-credentials: true
- name: Prepare release version
run: |
dist/release/bump_version.sh "$VERSION" "$(date +%F)"
cargo update --package termscp --precise "$VERSION"
cargo metadata --locked --no-deps --format-version 1 > /dev/null
- name: Download build artifacts
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
with:
pattern: build-*
path: dl
merge-multiple: true
- name: Download release notes
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
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@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
ref: ${{ needs.prepare.outputs.prepared_ref }}
persist-credentials: false
fetch-depth: 0
fetch-tags: true
- name: Prepare release version
run: |
dist/release/bump_version.sh "$VERSION" "$(date +%F)"
cargo update --package termscp --precise "$VERSION"
cargo metadata --locked --no-deps --format-version 1 > /dev/null
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- 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@c6f97d42243bad5fab37ca0427f495c86d5b1a18 # v1.0.5
- name: Publish to crates.io
env:
CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
run: just publish_crate
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/
+36
View File
@@ -0,0 +1,36 @@
name: Site
on:
pull_request:
branches: [main]
push:
branches: [main]
permissions:
contents: read
jobs:
build-site:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: 24
cache: npm
cache-dependency-path: site/package-lock.json
- name: Install just
uses: extractions/setup-just@53165ef7e734c5c07cb06b3c8e7b647c5aa16db3 # v4
- name: Install dependencies
run: just site_install
- name: Format
run: just site_fmt_check
- name: Lint
run: just site_check
- name: Test
run: just site_test
- name: Build
run: just site_build
+27
View File
@@ -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@4391f3da665fdf50b6810c1a66712fb9ba21aa93 # v11.0.0
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
-19
View File
@@ -1,19 +0,0 @@
name: Windows
on: [push, pull_request]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: windows-2019
steps:
- uses: actions/checkout@v2
- name: Build
run: cargo build
- name: Run tests
run: cargo test --verbose --lib --features github-actions -- --test-threads 1
- name: Clippy
run: cargo clippy
+11
View File
@@ -21,3 +21,14 @@ dist/pkgs/arch/*.tar.gz
# Macos
.DS_Store
dist/pkgs/
dist/build/macos/openssl/
.idea/
.claude/
# brainstorming visual companion
.superpowers/
docs/*/book/
+21
View File
@@ -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"
]
}
Symlink
+1
View File
@@ -0,0 +1 @@
CLAUDE.md
+63
View File
@@ -0,0 +1,63 @@
# AI Policy
The maintainers of this project don't want to interact directly with bots.
Contributions must come from a human who understands the submitted code or text,
can explain it, and is responsible for its quality as if they wrote it
themselves. Using AI as a tool to help you write or reason about a contribution
is fine; submitting AI output you don't understand, or relaying messages
between a maintainer and an AI, is not.
If you wish to include context from an interaction with AI in your comments, it
must be in a quote block (e.g., using `>`) and disclosed as such. It must be
accompanied by human commentary explaining the relevance and implications of
the context.
If you plan to contribute to termscp using AI tools, you **must** read,
understand and follow this policy.
## Disclosure
You **must** disclose the use of AI tools in your contributions. You
**must** perform this disclosure through the pull request template; filing
PRs without using the pull request template is a violation of this policy.
This applies to any AI tool that generated or substantially shaped the content
you submit — code, prose or commit messages — including agents, chat assistants
and AI-assisted editors. Mechanical editor autocompletion of a few characters
does not need to be disclosed; if in doubt, disclose.
## Translations
AI is useful when communicating as a non-native English speaker. If you are
using AI to edit your comments for this purpose, please take the time to ensure
it reflects your own voice and ideas.
## Provenance and licensing
You are responsible for the provenance of anything you submit. AI tools can
reproduce code or text from their training data verbatim, which may carry a
license incompatible with this project. By contributing, you confirm the work
is yours to submit under the project's license and does not infringe a third
party's rights. The same standard that applies to code you write by hand.
## Consequences
Violating this policy may get your contribution rejected and, for repeated or
egregious violations, get you blocked from the project without further warning.
## Examples
Examples of things that are not allowed:
- Point an agent to a GitHub issue, ask it to solve the issue and open a PR,
without understanding the issue, the PR, or testing the solution yourself.
- Copy responses from the AI when replying to questions from maintainers,
without understanding the question or the response.
In other words, you should not "play telephone" between your AI-generated code,
the reviewer, and the AI tool.
## Inspiration
This AI policy was inspired by:
- [release-plz](https://github.com/release-plz/.github/blob/main/AI_POLICY.md)
+1007 -357
View File
File diff suppressed because it is too large Load Diff
+116
View File
@@ -0,0 +1,116 @@
# 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, GCS, 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.98.0)
- **UI Framework**: tuirealm v3 (built on crossterm)
- **File Transfer**: remotefs ecosystem
## Build & Development Commands
Task runner is `just` (modular recipes under `just/*.just`, imported by root `justfile`). Run `just --list` for the full set.
```bash
# Build
just build_crates # cargo build --workspace
just build_crates "--release"
cargo build --no-default-features # minimal build without SMB/keyring (no just recipe)
# Test (CI-equivalent)
just test "--no-default-features --features github-actions --no-fail-fast"
# Run a single test / a module (use cargo directly, just recipes don't take test names)
cargo test <test_name> -- --nocapture
cargo test --lib filetransfer::
cargo test --lib config::params::tests
# Lint
just clippy "-- -D warnings"
# Format (dprint: Markdown, TOML, YAML, and Rust via nightly rustfmt)
just fmt_check # check only
just fmt # fix
# All code checks at once (fmt_check, clippy -D warnings, doc, deny, install script lint)
just check_code
```
### 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`, `GoogleCloudStorageParams`, `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 `just fmt` and `just clippy "-- -D warnings"` 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
- All code must be cross-platform compatible (Windows, macOS, Linux) — avoid POSIX-only APIs, hardcoded path separators, or shell-specific behavior unless gated behind the `posix`/`win` cfg aliases
+106 -50
View File
@@ -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
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- 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 email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
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
+25 -11
View File
@@ -1,7 +1,7 @@
# 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)
@@ -9,6 +9,7 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
- [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)
@@ -19,9 +20,13 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
## Project mission
termscp was born because, as a terminal lover and Linux user, I wanted something like WinSCP on Linux and on terminal. I my previous job I used SFTP/SCP pratically everyday and that made me to desire an application like termscp so much, that eventually I started to work on it in the spare time. I saw there was a very cool library to create terminal user interface (`tui-rs`), so I started to code it. I wrote termscp as an experiment, I designed kinda nothing at the time. I just said
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.
> 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".
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.
@@ -45,6 +50,7 @@ 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
@@ -61,7 +67,7 @@ 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](docs/man.md) the location of the log file.
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:
@@ -71,6 +77,15 @@ Maintainers will may add additional labels to your issue:
- **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.
@@ -84,8 +99,6 @@ Said so, follow these steps:
- Open an issue using the `feature request` template describing with accuracy your suggestion
- Wait for the maintainer feedback on your idea
If you want to implement the feature by yourself and your suggestion gets approved, start writing the code. Remember that on [docs.rs](https://docs.rs/termscp) there is the documentation for the project. Open a PR related to your issue. See [Pull request process for more details](#pull-request-process)
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.
@@ -97,9 +110,10 @@ Always mind that your suggestion, may be rejected: I'll always provide a feedbac
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/veeso/termscp/issues)
- New file transfers: for further details see [Implementing File Transfer](#implementing-file-transfers)
- Code optimizations: any optimization to the code is welcome
- **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 a new issue first.
@@ -124,7 +138,7 @@ Let's make it simple and clear:
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 libssh2 or 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.
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.
@@ -132,9 +146,9 @@ In addition to the process described for the PRs, I've also decided to introduce
## Developer contributions guide
You can view the developer guide [here](docs/developer.md).
You can view the developer guide [here](https://docs.termscp.rs/en-US/developer/developer.html).
---
Thank you for any contribution!
Thank you for any contribution!\
Christian Visintin
Generated
+6858 -746
View File
File diff suppressed because it is too large Load Diff
+115 -55
View File
@@ -1,17 +1,17 @@
[package]
authors = ["Christian Visintin"]
categories = ["command-line-utilities"]
description = "termscp is a feature rich terminal file transfer and explorer with support for SCP/SFTP/FTP"
documentation = "https://docs.rs/termscp"
edition = "2018"
homepage = "https://veeso.github.io/termscp/"
include = ["src/**/*", "LICENSE", "README.md", "CHANGELOG.md"]
keywords = ["scp-client", "sftp-client", "ftp-client", "winscp", "command-line-utility"]
license = "MIT"
name = "termscp"
version = "1.2.0"
authors = ["Christian Visintin <christian.visintin@veeso.dev>"]
categories = ["command-line-utilities"]
edition = "2024"
homepage = "https://termscp.rs"
include = ["/src/**/*", "/build.rs", "/LICENSE", "/README.md", "/CHANGELOG.md"]
keywords = ["terminal", "ftp", "scp", "sftp", "tui"]
license = "MIT"
readme = "README.md"
repository = "https://github.com/veeso/termscp"
version = "0.6.1"
rust-version = "1.98.0"
description = "termscp is a feature rich terminal file transfer and explorer with support for SCP/SFTP/FTP/Kube/S3/GCS/SMB/WebDAV"
[package.metadata.rpm]
package = "termscp"
@@ -22,55 +22,115 @@ 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>"
depends = ""
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.11"
argh = "0.1"
base64 = "0.23"
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-gcs = "0.1"
remotefs-kube = "0.4"
remotefs-smb = { version = "0.5", default-features = false, optional = true, features = ["find", "pavao"] }
remotefs-ssh = { version = "0.9", 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"] }
serde_json = "1"
shellexpand = "3"
simplelog = "0.12"
ssh2-config = "0.8"
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 = "4"
[build-dependencies]
cfg_aliases = "0.2"
[[bin]]
name = "termscp"
path = "src/main.rs"
[dependencies]
argh = "0.1.5"
bitflags = "1.3.2"
bytesize = "1.1.0"
chrono = "0.4.19"
content_inspector = "0.2.4"
crossterm = "0.20"
dirs = "3.0.1"
edit = "0.1.3"
hostname = "0.3.1"
keyring = { version = "0.10.1", optional = true }
lazy_static = "1.4.0"
log = "0.4.14"
magic-crypt = "3.1.7"
open = "2.0.1"
rand = "0.8.4"
regex = "1.5.4"
rpassword = "5.0.1"
serde = { version = "^1.0.0", features = [ "derive" ] }
simplelog = "0.10.0"
ssh2 = "0.9.0"
suppaftp = { version = "4.1.2", features = [ "secure" ] }
tempfile = "3.1.0"
textwrap = "0.14.2"
thiserror = "^1.0.0"
toml = "0.5.8"
tui-realm-stdlib = "0.6.0"
tuirealm = "0.6.0"
ureq = { version = "2.1.0", features = [ "json" ] }
whoami = "1.1.1"
wildmatch = "2.0.0"
[lints.rust]
trivial_numeric_casts = "warn"
unsafe_op_in_unsafe_fn = "warn"
unused_lifetimes = "warn"
[dev-dependencies]
pretty_assertions = "0.7.2"
[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"
[features]
default = [ "with-keyring" ]
github-actions = []
with-containers = []
with-keyring = [ "keyring" ]
[profile.dev]
incremental = true
[target."cfg(target_family = \"unix\")"]
[target."cfg(target_family = \"unix\")".dependencies]
users = "0.11.0"
[target."cfg(target_os = \"windows\")"]
[target."cfg(target_os = \"windows\")".dependencies]
path-slash = "0.1.4"
[profile.release]
strip = true
+11
View File
@@ -0,0 +1,11 @@
import "./just/build.just"
import "./just/changelog.just"
import "./just/code_check.just"
import "./just/publish.just"
import "./just/run.just"
import "./just/site.just"
import "./just/test.just"
# Lists all the available commands
default:
@just --list
+1 -1
View File
@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2021 Christian Visintin
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
+104 -74
View File
@@ -1,30 +1,41 @@
# termscp
<p align="center">
<img src="/assets/images/termscp.svg" width="256" height="256" />
<img src="/assets/images/termscp.svg" alt="termscp logo" width="256" height="256" />
</p>
<p align="center">~ A feature rich terminal file transfer ~</p>
<p align="center">
<a href="https://veeso.github.io/termscp/" target="_blank">Website</a>
<a href="https://termscp.rs" target="_blank">Website</a>
·
<a href="https://veeso.github.io/termscp/#get-started" target="_blank">Installation</a>
<a href="https://termscp.rs/install" target="_blank">Installation</a>
·
<a href="https://veeso.github.io/termscp/#user-manual" target="_blank">User manual</a>
<a href="https://docs.termscp.rs" target="_blank">User manual</a>
</p>
<p align="center">Developed by <a href="https://veeso.github.io/">@veeso</a></p>
<p align="center">Current version: 0.6.1 (31/08/2021)</p>
<p align="center">
<a
href="/docs/zh-CN/README.md"
><img
height="20"
src="/assets/images/flags/cn.png"
alt="简体中文"
/></a>
</p>
[![License: MIT](https://img.shields.io/badge/License-MIT-teal.svg)](https://opensource.org/licenses/MIT) [![Stars](https://img.shields.io/github/stars/veeso/termscp.svg)](https://github.com/veeso/termscp) [![Downloads](https://img.shields.io/crates/d/termscp.svg)](https://crates.io/crates/termscp) [![Crates.io](https://img.shields.io/badge/crates.io-v0.6.1-orange.svg)](https://crates.io/crates/termscp) [![Docs](https://docs.rs/termscp/badge.svg)](https://docs.rs/termscp)
<p align="center">Developed by <a href="https://veeso.me/" target="_blank">@veeso</a></p>
[![Linux](https://github.com/veeso/termscp/workflows/Linux/badge.svg)](https://github.com/veeso/termscp/actions) [![MacOs](https://github.com/veeso/termscp/workflows/MacOS/badge.svg)](https://github.com/veeso/termscp/actions) [![Windows](https://github.com/veeso/termscp/workflows/Windows/badge.svg)](https://github.com/veeso/termscp/actions) [![FreeBSD](https://github.com/veeso/termscp/workflows/FreeBSD/badge.svg)](https://github.com/veeso/termscp/actions) [![Coverage Status](https://coveralls.io/repos/github/veeso/termscp/badge.svg)](https://coveralls.io/github/veeso/termscp)
[![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)
---
## About termscp 🖥
Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP. 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.
Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/Kube/S3/Google Cloud Storage (GCS)/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)
@@ -32,106 +43,122 @@ Termscp is a feature rich terminal file transfer and explorer, with support for
## Features 🎁
- 📁 Different communication protocols
- SFTP
- SCP
- FTP and FTPS
- 🖥 Explore and operate on the remote and on the local machine file system with a handy UI
- 📁 Different communication protocols
- **SFTP**
- **SCP**
- **FTP** and **FTPS**
- **Kube**
- **S3**
- **Google Cloud Storage (GCS)**
- **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 text files with your favourite text editor
- 💁 SFTP/SCP authentication through SSH keys and username/password
- 🐧 Compatible with Windows, Linux, BSD and MacOS
- ✏ Customizable
- ⭐ 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
- 🔐 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
- 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
---
## 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).
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
curl --proto '=https' --tlsv1.2 -sSLf "https://git.io/JBhDb" | sh
curl --proto '=https' --tlsv1.2 -sSLf https://termscp.rs/install.sh | sh
```
while if you're a Windows user, you can install termscp with [Chocolatey](https://chocolatey.org/).
> ❗ MacOs installation requires [Homebrew](https://brew.sh/), otherwise the Rust compiler will be installed
For more information or other platforms, please visit [veeso.github.io](https://veeso.github.io/termscp/#get-started) to view all installation methods.
if you're a Windows user, you can install termscp from PowerShell with a single command:
```ps
irm https://termscp.rs/install.ps1 | iex
```
or, alternatively, with [Chocolatey](https://chocolatey.org/):
```ps
choco install termscp
```
NetBSD users can install termscp from the official repositories.
```sh
pkgin install termscp
```
Arch Linux users can install termscp from the official repositories.
```sh
pacman -S termscp
```
For more information or other platforms, please visit [termscp.rs](https://termscp.rs/install) to view all installation methods.
⚠️ If you're looking on how to update termscp just run termscp from CLI with: `(sudo) termscp update` ⚠️
### Requirements ❗
The official Linux binaries and `.deb` packages are statically linked against
musl and have **no runtime requirements**: they run on any distribution and
any glibc version.
These are only required to build termscp from source:
- **Linux** users:
- libssh
- libdbus-1
- **BSD** users:
- libssh
- pkg-config
- libsmbclient
- **FreeBSD** or, **NetBSD** users:
- dbus
- pkgconf
- libsmbclient
### Optional Requirements ✔️
These requirements are not forcely required to run termscp, but to enjoy all of its features
These requirements are not forced required to run termscp, but to enjoy all of its features
- **Linux/BSD** users:
- **Linux/FreeBSD** users:
- To **open** files via `V` (at least one of these)
- *xdg-open*
- *gio*
- *gnome-open*
- *kde-open*
- _xdg-open_
- _gio_
- _gnome-open_
- _kde-open_
- **Linux** users:
- A keyring manager: read more in the [User manual](docs/man.md#linux-keyring)
- 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)
---
## Buy me a coffee ☕
## User manual 📚
If you like termscp and you'd love to see the project to grow, please consider a little donation 🥳
[![Buy-me-a-coffee](https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=&slug=veeso&button_colour=404040&font_colour=ffffff&font_family=Comic&outline_colour=ffffff&coffee_colour=FFDD00)](https://www.buymeacoffee.com/veeso)
---
## Documentation 📚
The developer documentation can be found on Rust Docs at <https://docs.rs/termscp>
---
## Known issues 🧻
- `NoSuchFileOrDirectory` on connect (WSL1): 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`, or install it through the appropriate package format (e.g. deb).
The user manual can be found on [termscp's documentation website](https://docs.termscp.rs).
---
## Upcoming Features 🧪
Major termscp releases will now be seasonal, so expect 4 major updates during the year.
Planned for *🍁 Autumn update 🍇*:
- **Self-update ⬇️**: In order to increase users updating termscp, I want to provide the possibility to update termscp directly from application, when a new update is available.
- **AWS S3 support 🪣**: I'll use `rust-s3` library to implement this. This is really big **Maybe** for the autumn update and might be moved to the Winter update.
- **Prompt before replacing files ☢️**: Possibility to configure whether a prompt should be displayed before replacing files.
Planned for *❄️ Winter update ⛄*:
- **SMB Support 🎉**: This will require a long time to be implemented, since I'm currently working on a Rust native SMB library, since I don't want to add new C-bindings. ~~Fear the 🦚~~
- **Configuration profile for bookmarks 📚**: Basically this feature adds the possibility to have a specific setup for a certain host, instead of having only one global configuration.
Along to new features, termscp developments is now focused on UX and performance improvements, so if you have any suggestion, feel free to open an issue.
See [Milestones](https://github.com/veeso/termscp/milestones)
---
@@ -140,6 +167,8 @@ Along to new features, termscp developments is now focused on UX and performance
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.
An **appreciated** contribution would be a translation of the user manual and readme in **other languages**
Please follow [our contributing guidelines](CONTRIBUTING.md)
---
@@ -152,18 +181,19 @@ View termscp's changelog [HERE](CHANGELOG.md)
## 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)
- [suppaftp](https://github.com/veeso/suppaftp)
- [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)
Binary file not shown.

Before

Width:  |  Height:  |  Size: 190 KiB

After

Width:  |  Height:  |  Size: 336 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 313 KiB

After

Width:  |  Height:  |  Size: 937 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.1 MiB

After

Width:  |  Height:  |  Size: 3.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1002 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 484 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.8 KiB

After

Width:  |  Height:  |  Size: 2.8 KiB

+1 -1
View File
@@ -1 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:bx="https://boxy-svg.com" viewBox="0 0 500 500"><path style="fill:#404040" d="M 15 0 H 484 A 16 16 0 0 1 500 16 V 47.312 H 0 V 15 A 15 15 0 0 1 15 0 Z" bx:shape="rect 0 0 500 47.312 15 16 0 0 1@05baa068"/><circle style="fill:#ea4444" cx="29.473" cy="23.011" r="7.344"/><circle style="fill:#eac944" cx="58.177" cy="22.543" r="7.344" transform="matrix(1, 0, 0, 1.031863, -5.389861, -0.016285)"/><circle style="fill:#34b938" cx="58.177" cy="22.543" r="7.344" transform="matrix(1, 0, 0, 1.031863, 17.888227, -0.016285)"/><rect width="500" height="452.688" y="47.312" style="fill:#31363b"/><polygon style="stroke:#000;fill:#f0f0f0" points="71.581 100 224.35 252.769 77.119 400 25.235 348.115 122.193 251.156 22.129 151.093"/><rect style="fill:#f0f0f0" width="242.408" height="49.262" x="235.188" y="381.519" rx="10" ry="10"/><g transform="matrix(0.513677, 0, 0, 0.513677, 257.101013, 152.253387)"><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></svg>
<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>

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 227 KiB

After

Width:  |  Height:  |  Size: 224 KiB

+16
View File
@@ -0,0 +1,16 @@
use cfg_aliases::cfg_aliases;
fn main() {
// 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") }
}
}
+46
View File
@@ -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"
+84
View File
@@ -0,0 +1,84 @@
# cargo-deny configuration for termscp.
#
# Run locally with `just deny`. The same command runs in CI and enforces
# advisories, licenses, bans, and dependency sources.
#
# Docs: https://embarkstudios.github.io/cargo-deny/
[graph]
all-features = true
[output]
feature-depth = 1
[advisories]
db-urls = ["https://github.com/rustsec/advisory-db"]
yanked = "deny"
unmaintained = "all"
# These are temporary, reachable transitive-risk acceptances owned by the
# termscp maintainers. Review or remove every exception by 2026-12-31. The
# upgrade target is a remotefs/self_update release line that accepts each fixed
# dependency version; until then, connections to untrusted endpoints remain an
# acknowledged denial-of-service and certificate-validation risk.
ignore = [
# h2 0.3 is retained transitively by the reqwest 0.11/AWS HTTP stack; its
# dependency constraints cannot select the fixed h2 0.4 release.
{ id = "RUSTSEC-2026-0258", reason = "owner: termscp maintainers; review by 2026-12-31; upgrade reqwest/AWS stack to fixed h2" },
# number_prefix is retained by self_update through indicatif. It is
# unmaintained, but has no reported vulnerability or compatible replacement.
{ id = "RUSTSEC-2025-0119", reason = "owner: termscp maintainers; review by 2026-12-31; upgrade self_update/indicatif" },
# Both affected quick-xml lines are constrained by remotefs-webdav and
# self_update to versions older than the fixed 0.41 release.
{ id = "RUSTSEC-2026-0194", reason = "owner: termscp maintainers; review by 2026-12-31; upgrade remotefs-webdav/self_update to quick-xml >=0.41" },
{ id = "RUSTSEC-2026-0195", reason = "owner: termscp maintainers; review by 2026-12-31; upgrade remotefs-webdav/self_update to quick-xml >=0.41" },
# The SSH stack requires RSA, for which RustSec reports no safe upgrade.
{ id = "RUSTSEC-2023-0071", reason = "owner: termscp maintainers; review by 2026-12-31; replace RSA dependency when upstream fix exists" },
# rustls-pemfile is retained by the WebDAV and Kubernetes clients. Both
# versions are unmaintained but have no reported vulnerability.
{ id = "RUSTSEC-2025-0134", reason = "owner: termscp maintainers; review by 2026-12-31; upgrade WebDAV/Kubernetes clients away from rustls-pemfile" },
]
[licenses]
allow = [
"Apache-2.0",
"BSD-1-Clause",
"BSD-2-Clause",
"BSD-3-Clause",
"BSL-1.0",
"CC0-1.0",
"CDLA-Permissive-2.0",
"ISC",
"MIT",
"MIT-0",
"MPL-2.0",
"Unicode-3.0",
"Unlicense",
"Zlib",
]
confidence-threshold = 0.8
exceptions = [
# The WebDAV backend currently depends on rustydav, which declares GPL-3.0.
# Keep this exception crate-scoped so no other GPL dependency is admitted.
{ allow = ["GPL-3.0"], crate = "rustydav" },
]
[licenses.private]
ignore = false
[bans]
multiple-versions = "warn"
wildcards = "deny"
allow-wildcard-paths = true
highlight = "all"
workspace-default-features = "allow"
external-default-features = "allow"
allow = []
deny = []
skip = []
skip-tree = []
[sources]
unknown-registry = "deny"
unknown-git = "deny"
allow-registry = ["https://github.com/rust-lang/crates.io-index"]
allow-git = []
-25
View File
@@ -1,25 +0,0 @@
# Build with Docker
- [Build with Docker](#build-with-docker)
- [Prerequisites](#prerequisites)
- [Build](#build)
---
## Prerequisites
- Docker
## Build
1. Build x86_64
this will build termscp for:
- Linux x86_64 Deb packages
- Linux x86_64 RPM packages
- Windows x86_64 MSVC packages
```sh
```
-32
View File
@@ -1,32 +0,0 @@
#!/bin/bash
if [ -z "$1" ]; then
echo "Usage: deploy.sh <version>"
exit 1
fi
VERSION=$1
set -e # Don't fail
# Create pkgs directory
cd ..
PKGS_DIR=$(pwd)/pkgs
cd -
mkdir -p ${PKGS_DIR}/
# Build x86_64_deb
cd x86_64_debian9/
docker build --tag termscp-${VERSION}-x86_64_debian9 .
cd -
mkdir -p ${PKGS_DIR}/deb/
CONTAINER_NAME=$(docker create termscp-${VERSION}-x86_64_debian9 termscp-${VERSION}-x86_64_debian9)
docker cp ${CONTAINER_NAME}:/usr/src/termscp/target/debian/termscp_${VERSION}_amd64.deb ${PKGS_DIR}/deb/
# Build x86_64_centos7
cd x86_64_centos7/
docker build --tag termscp-${VERSION}-x86_64_centos7 .
cd -
mkdir -p ${PKGS_DIR}/rpm/
CONTAINER_NAME=$(docker create termscp-${VERSION}-x86_64_centos7 termscp-${VERSION}-x86_64_centos7)
docker cp ${CONTAINER_NAME}:/usr/src/termscp/target/release/rpmbuild/RPMS/x86_64/termscp-${VERSION}-1.el7.x86_64.rpm ${PKGS_DIR}/rpm/termscp-${VERSION}-1.x86_64.rpm
exit $?
-19
View File
@@ -1,19 +0,0 @@
FROM rust:1.48.0 AS builder
WORKDIR /usr/src/
# Add toolchains
RUN rustup target add x86_64-unknown-linux-gnu
# Install dependencies
RUN apt update && apt install -y rpm
# Clone repository
RUN git clone https://github.com/veeso/termscp.git
# Set workdir to termscp
WORKDIR /usr/src/termscp/
# Install cargo RPM/Deb
RUN cargo install cargo-deb cargo-rpm
# Build for x86_64
RUN cargo build --release --target x86_64-unknown-linux-gnu
# Build pkgs
RUN cargo deb && cargo rpm init && cargo rpm build
CMD ["sh"]
-26
View File
@@ -1,26 +0,0 @@
FROM centos:centos7 as builder
WORKDIR /usr/src/
# Install dependencies
RUN yum -y install \
git \
gcc \
openssl \
pkgconfig \
dbus-devel \
openssl-devel
# Install rust
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > /tmp/rust.sh && \
chmod +x /tmp/rust.sh && \
/tmp/rust.sh -y
# Clone repository
RUN git clone https://github.com/veeso/termscp.git
# Set workdir to termscp
WORKDIR /usr/src/termscp/
# Install cargo arxch
RUN source $HOME/.cargo/env && cargo install cargo-rpm
# Build for x86_64
RUN source $HOME/.cargo/env && cargo build --release
# Build pkgs
RUN source $HOME/.cargo/env && yum -y install rpm-build && cargo rpm init && cargo rpm build
CMD ["sh"]
-29
View File
@@ -1,29 +0,0 @@
FROM debian:jessie
WORKDIR /usr/src/
# Install dependencies
RUN apt update && apt install -y \
git \
gcc \
pkg-config \
libssl-dev \
libssh2-1-dev \
libdbus-1-dev \
curl
# Install rust
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > /tmp/rust.sh && \
chmod +x /tmp/rust.sh && \
/tmp/rust.sh -y
# Clone repository
RUN git clone https://github.com/veeso/termscp.git
# Set workdir to termscp
WORKDIR /usr/src/termscp/
# Install cargo deb
RUN . $HOME/.cargo/env && cargo install cargo-deb
# Build for x86_64
RUN . $HOME/.cargo/env && cargo build --release
# Build pkgs
RUN . $HOME/.cargo/env && cargo deb
CMD ["sh"]
-29
View File
@@ -1,29 +0,0 @@
FROM debian:stretch
WORKDIR /usr/src/
# Install dependencies
RUN apt update && apt install -y \
git \
gcc \
pkg-config \
libssl-dev \
libssh2-1-dev \
libdbus-1-dev \
curl
# Install rust
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > /tmp/rust.sh && \
chmod +x /tmp/rust.sh && \
/tmp/rust.sh -y
# Clone repository
RUN git clone https://github.com/veeso/termscp.git
# Set workdir to termscp
WORKDIR /usr/src/termscp/
# Install cargo deb
RUN . $HOME/.cargo/env && cargo install cargo-deb
# Build for x86_64
RUN . $HOME/.cargo/env && cargo build --release
# Build pkgs
RUN . $HOME/.cargo/env && cargo deb
CMD ["sh"]
+8
View File
@@ -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/`
+58
View File
@@ -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.2.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>
+25
View File
@@ -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.2.0/termscp-v1.2.0-msvc.zip'
$checksum = 'f6ad6c62f1578562f9af4bcee93bd4cc429cb52219c3636359b008db8789587e'
} else {
$url = 'https://github.com/veeso/termscp/releases/download/v1.2.0/termscp-v1.2.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
Vendored
-11
View File
@@ -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 $?
-17
View File
@@ -1,17 +0,0 @@
name: "termscp"
version: 0.6.1
origin: veeso/termscp
comment: "A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP"
desc: <<EOD
A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP
EOD
arch: "amd64"
www: "https://veeso.github.io/termscp/"
maintainer: "christian.visintin1997@gmail.com"
prefix: "/usr/local/bin"
deps: {
libssh: {origin: security/libssh, version: 0.9.5}
}
files: {
/usr/local/bin/termscp: "87543d13b11b6e601ba8cdde9d704c80dc3515f1681fbf71fd0b31d7206efc09"
}
Vendored Executable
+52
View File
@@ -0,0 +1,52 @@
#!/usr/bin/env sh
# Builds a static musl termscp release binary for the given target triple
# inside a pinned Alpine container.
#
# Usage: dist/release/build_musl.sh <target-triple>
set -eu
IMAGE="rust:1.98-alpine3.22"
TARGET="${1:-}"
if [ -z "$TARGET" ]; then
echo "usage: $0 <target-triple>" >&2
exit 2
fi
case "$TARGET" in
x86_64-unknown-linux-musl) PLATFORM="linux/amd64" ;;
aarch64-unknown-linux-musl) PLATFORM="linux/arm64" ;;
*)
echo "unsupported target: $TARGET" >&2
exit 2
;;
esac
WORKSPACE="$(CDPATH='' cd -- "$(dirname -- "$0")/../.." && pwd)"
# The container appends a [patch.crates-io] section to Cargo.toml and updates
# Cargo.lock; keep byte-exact copies so the workspace is clean afterwards.
BACKUP_DIR="$(mktemp -d)"
cp -p "$WORKSPACE/Cargo.toml" "$BACKUP_DIR/Cargo.toml"
cp -p "$WORKSPACE/Cargo.lock" "$BACKUP_DIR/Cargo.lock"
restore_manifests() {
cp -p "$BACKUP_DIR/Cargo.toml" "$WORKSPACE/Cargo.toml"
cp -p "$BACKUP_DIR/Cargo.lock" "$WORKSPACE/Cargo.lock"
rm -rf "$BACKUP_DIR"
}
trap restore_manifests EXIT
HOST_UID="$(id -u)"
HOST_GID="$(id -g)"
export TARGET HOST_UID HOST_GID
docker run --rm \
--platform "$PLATFORM" \
--env TARGET \
--env HOST_UID \
--env HOST_GID \
--volume "$WORKSPACE:/work" \
--workdir /work \
"$IMAGE" \
sh /work/dist/release/build_musl_container.sh
+143
View File
@@ -0,0 +1,143 @@
#!/usr/bin/env sh
# Builds a static musl termscp binary. Runs INSIDE the Alpine container
# started by dist/release/build_musl.sh; /work is the mounted workspace.
#
# Required environment: TARGET, HOST_UID, HOST_GID.
set -eux
NETTLE_VERSION="3.10.1"
GNUTLS_VERSION="3.8.13"
PAVAO_SRC_VERSION="4.24.6"
cleanup() {
chown -R "$HOST_UID:$HOST_GID" /work
}
trap cleanup EXIT
apk add --no-cache \
bison \
binutils \
build-base \
file \
flex \
git \
gnutls-dev \
libgit2-dev \
libgit2-static \
libunistring-dev \
libunistring-static \
linux-headers \
openssl-dev \
openssl-libs-static \
perl \
perl-parse-yapp \
pkgconf \
python3 \
wget \
xz \
zlib-dev \
zlib-static
rustup target add "$TARGET"
cargo fetch --locked
NATIVE_CFLAGS="-O2 -fPIC"
if [ "$TARGET" = "aarch64-unknown-linux-musl" ]; then
NATIVE_CFLAGS="$NATIVE_CFLAGS -mno-outline-atomics"
fi
export CFLAGS="$NATIVE_CFLAGS"
# -- static nettle (GnuTLS crypto backend); mini-gmp avoids a GMP dependency
mkdir -p /tmp/native
wget -q "https://ftp.gnu.org/gnu/nettle/nettle-$NETTLE_VERSION.tar.gz" \
-O /tmp/native/nettle.tar.gz
tar -xzf /tmp/native/nettle.tar.gz -C /tmp/native
cd "/tmp/native/nettle-$NETTLE_VERSION"
./configure \
--prefix=/tmp/native/nettle \
--disable-shared \
--enable-static \
--disable-documentation \
--enable-mini-gmp
make -j"$(getconf _NPROCESSORS_ONLN)"
make install
# -- static GnuTLS; every optional backend is disabled so nothing links
# against a shared library
wget -q "https://www.gnupg.org/ftp/gcrypt/gnutls/v3.8/gnutls-$GNUTLS_VERSION.tar.xz" \
-O /tmp/native/gnutls.tar.xz
tar -xf /tmp/native/gnutls.tar.xz -C /tmp/native
cd "/tmp/native/gnutls-$GNUTLS_VERSION"
PKG_CONFIG_PATH=/tmp/native/nettle/lib/pkgconfig \
./configure \
--prefix=/tmp/native/gnutls \
--disable-shared \
--enable-static \
--disable-doc \
--disable-tests \
--disable-nls \
--disable-hardware-acceleration \
--with-nettle-mini \
--with-included-libtasn1 \
--with-included-unistring \
--without-idn \
--without-p11-kit \
--without-brotli \
--without-zstd \
--without-zlib
make -j"$(getconf _NPROCESSORS_ONLN)"
make install
# -- flatten gnutls.pc: pkg-config must hand the linker the static archives
# directly, with no Requires.private chain to resolve
mkdir -p /tmp/native/pkgconfig
sed \
-e "s#^Libs:.*#Libs: -L/tmp/native/gnutls/lib -lgnutls -latomic -L/tmp/native/nettle/lib -lhogweed -lnettle#" \
-e "/^Requires.private:/d" \
-e "s#^Cflags:.*#Cflags: -I/tmp/native/gnutls/include -I/tmp/native/nettle/include#" \
/tmp/native/gnutls/lib/pkgconfig/gnutls.pc \
> /tmp/native/pkgconfig/gnutls.pc
# -- pavao-src: Samba's replacement library omits two sources that musl needs
cd /work
PAVAO_SRC=$(find "${CARGO_HOME:-/usr/local/cargo}/registry/src" \
-type d -name "pavao-src-$PAVAO_SRC_VERSION" -print -quit)
test -n "$PAVAO_SRC"
cp -R "$PAVAO_SRC" /tmp/pavao-src
perl -0pi -e "s#( \\\"lib/replace/replace\\.c\\\",\\n)#\$1 \\\"lib/replace/closefrom.c\\\",\\n \\\"lib/replace/strptime.c\\\",\\n#" \
/tmp/pavao-src/src/lib.rs
cat >> Cargo.toml <<EOF
[patch.crates-io]
pavao-src = { path = "/tmp/pavao-src" }
EOF
cargo update -p "pavao-src@$PAVAO_SRC_VERSION"
export PKG_CONFIG_ALL_STATIC=1
export PKG_CONFIG_PATH=/tmp/native/pkgconfig:/tmp/native/nettle/lib/pkgconfig:/usr/lib/pkgconfig
export RUSTFLAGS="-C target-feature=+crt-static -C link-arg=-static"
cargo build --locked --release --target "$TARGET" --features smb-vendored
# -- prove the binary is static: no interpreter, no shared libraries
file "target/$TARGET/release/termscp"
if readelf -l "target/$TARGET/release/termscp" > /tmp/program-headers.txt; then
cat /tmp/program-headers.txt
else
status=$?
cat /tmp/program-headers.txt
exit "$status"
fi
if readelf -d "target/$TARGET/release/termscp" > /tmp/dynamic-section.txt; then
cat /tmp/dynamic-section.txt
else
status=$?
cat /tmp/dynamic-section.txt
exit "$status"
fi
if grep -q INTERP /tmp/program-headers.txt; then
exit 1
fi
if grep -q NEEDED /tmp/dynamic-section.txt; then
exit 1
fi
Vendored Executable
+38
View File
@@ -0,0 +1,38 @@
#!/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]}"
if [[ ! "$VERSION" =~ ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$ ]]; then
echo "invalid release version: $VERSION (expected MAJOR.MINOR.PATCH)" >&2
exit 2
fi
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)"
+85
View File
@@ -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"
Vendored
-16
View File
@@ -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 $?
+1
View File
@@ -0,0 +1 @@
docs.termscp.rs
-73
View File
@@ -1,73 +0,0 @@
# Developer Manual
Document audience: developers
- [Developer Manual](#developer-manual)
- [How to test](#how-to-test)
- [How termscp works](#how-termscp-works)
- [Activities](#activities)
- [The Context](#the-context)
Welcome to the developer manual for termscp. This chapter DOESN'T 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 guide lines to implement stuff such as file transfers and add features to the user interface.
## How to test
First an introduction to tests.
Usually it's enough to run `cargo test`, but please note that whenever you're working on file transfer you'll need one more step.
In order to run tests with file transfers, you need to start the file transfer server containers, which can be started via `docker`.
To run all tests with file transfers just run: `./tests/test.sh`
---
## 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.
In addition to the 4 main components, other have been added through the time:
- **config**: this module provides the configuration schema and serialization methods for it.
- **fs**: this modules exposes the FsEntry entity and the explorers. The explorers are structs which hold the content of the current directory; they also they take of filtering files up to your preferences and format file entries based on your configuration.
- **system**: the system module provides a way to actually interact with the configuration, the ssh key storage and with the bookmarks.
- **utils**: contains the utilities used by pretty much all the project.
## 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 and I've worked with different languages and frameworks in my career, so for this project I've decided to get what I like the most from different frameworks to implement it.
My approach was this:
- **Activities on top**: each "page" is an Activity and an `Activity Manager` handles them. I got inspired by Android for this case. I think that's a good way to implement the ui in case like this, where you have different pages, each one with their view, their components and their logics. Activities work with the `Context`, which is a data holder for different data, which are shared and common between the activities.
- **Activities display Views**: Each activity can show different views. A view 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 component active, so you need to handle this; but at the same time you also have to give focus to the previously active component if the current one is destroyed. So basically view takes care of all this stuff.
- **Components**: I've decided to write around `tui` in order to re-use widgets. To do so I've implemented the `Component` trait. To implement traits I got inspired by [React](https://reactjs.org/). Each component has its *Properties* and can have its *States*. Then each component must be able to handle input events and to be updated with new properties. Last but not least, each component must provide a method to **render** itself.
- **Messages: an Elm based approach**: I was really satisfied with my implementation choices; the problem at this point was solving one of the biggest teardrops I've ever had with this project: **events**. Input events were really a pain to handle, since I had to handle states in the activity to handle which component was enabled etc. To solve this I got inspired by a wonderful language I had recently studied, which is [Elm](https://elm-lang.org/). Basically in Elm you implement your ui using three basic functions: **update**, **view** and **init**. View and init were pretty much already implemented here, but at this point I decided to implement also something like the **elm update function**. I came out with a huge match case to handle events inside a recursive function, which you can basically find in the `update.rs` file inside each activity. This match case handles a tuple, made out of the **component id** and the **input event** received from the view. It matches the two propeties against the input event we want to handle for each component *et voilà*.
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).
- `will_umount`: this method was added in 0.4.0 and returns whethere the activity should be destroyed. If so returns an ExitReason, which indicates why the activity should be terminated. 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`: this method finalizes the activity and drops it; this method returns the Context to the caller (the activity manager).
### The Context
The context is a structure which holds data which must be shared between activities. Everytime an Activity starts, the Context is taken by the activity, until it is destroyed, where finally the context is returned to the activity manager.
The context basically holds the following data:
- The **Localhost**: the local host structure
- The **File Transfer Params**: the current parameters set to connect to the remote
- The **Config Client**: the configuration client is a structure which provides functions to access the user configuration
- The **Store**: the store is a key-value storage which can hold any kind of data. This can be used to store states to share between activities or to keep persistence for heavy/slow tasks (such as checking for updates).
- The **Input handler**: the input handler is used to read input events from the keyboard
- The **Terminal**: the terminal is used to view the tui on the terminal
---
+37
View File
@@ -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)
+22
View File
@@ -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/GCS/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"
+76
View File
@@ -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.
+62
View File
@@ -0,0 +1,62 @@
# 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).
## SSH configuration behavior
In either SFTP or SCP authentication pane, after you change and leave the
`Host` field, termscp keeps the entered alias visible and fills the visible
`Port` and `Username` fields from the matching SSH configuration entry. If the
new Host does not match an entry, it resets Port to `22` and Username to empty.
`HostName` never replaces the alias in the form.
Bookmarks retain their saved Port and User values; the SSH configuration does
not silently override them. The configured file still provides `HostName` and
other supported SSH options when termscp connects.
@@ -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}
```
+28
View File
@@ -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.
+23
View File
@@ -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.
@@ -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.
+25
View File
@@ -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.
+113
View File
@@ -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 |
+128
View File
@@ -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.98.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, GCS,
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`.
+91
View File
@@ -0,0 +1,91 @@
# 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.
## SSH configuration precedence
For SFTP and SCP connections, termscp resolves CLI Username and Port values in
this order: explicit `Username`/`Port`, SSH configuration `User`/`Port`, then
the current OS user and Port `22`. Username and Port are resolved independently,
so an explicit value for one does not prevent SSH configuration from supplying
the other.
For example, `termscp myhost` uses the configured Port and User for `myhost`.
`termscp alice@myhost:22` uses `alice` and `22`, regardless of the SSH
configuration.
## 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`. For SFTP and SCP, an omitted Port or Username is taken from a
matching SSH configuration entry. If no value is configured, it falls back to
the protocol default port or the current OS user. Other protocols use their
default port and the current OS user.
```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, GCS, 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
```
@@ -0,0 +1,219 @@
# 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.
## Google Cloud Storage
termscp supports Google Cloud Storage (GCS) buckets through the Google Cloud
Storage JSON API.
Authentication-form fields:
- Bucket name (required)
- Endpoint (defaults to `https://storage.googleapis.com`)
- Optional service-account JSON path
Leave the service-account JSON path empty to use Application Default
Credentials (ADC). ADC can obtain credentials from
`GOOGLE_APPLICATION_CREDENTIALS`, local gcloud ADC credentials, or the Google
Cloud metadata service when termscp runs on Google Cloud infrastructure.
When a service-account JSON path is supplied, termscp reads that file when it
connects. Bookmarks store only the path and never copy the service-account JSON
or its private key.
The dedicated CLI syntax is:
```txt
gcs://<bucket>[:/working/directory]
```
CLI connections use ADC and the default endpoint. Use the authentication form
or a bookmark when you need a custom endpoint or a service-account JSON path.
The selected ADC identity or service account must have IAM permissions for the
storage operations you want to perform.
## SMB
Authentication-form fields:
- Server (address)
- Share
- Username
- Password
- Port (other systems only; default `445`)
- Workgroup (other systems only)
- SMB version (other systems only; default `Auto`)
On Windows the port, workgroup and SMB version fields are not used: the
operating system manages SMB protocol negotiation.
The SMB version field bounds the dialects offered during negotiation:
| Selection | Dialects negotiated |
| --------- | ----------------------- |
| Auto | SMB 2.0.2 through 3.1.1 |
| SMB1 | NT1 (CIFS) only |
| SMB2 | SMB 2.0.2 through 2.1 |
| SMB3 | SMB 3.0 through 3.1.1 |
`Auto` never negotiates SMB1. SMB1 is deprecated and insecure: select it only
for isolated legacy devices that support nothing newer. A warning is shown in
the form while SMB1 is selected.
Bookmarks store the selection under the `dialect` key of the SMB table
(`auto`, `smb1`, `smb2` or `smb3`). Bookmarks saved before this option existed
have no `dialect` key and behave as `Auto`. The address syntax below does not
carry a version; connections started from the command line use `Auto`.
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>
```
+102
View File
@@ -0,0 +1,102 @@
# 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
```
## Official binaries
Official release binaries are published for these targets:
- GNU/Linux:
- `x86_64-unknown-linux-musl`
- `aarch64-unknown-linux-musl`
- macOS:
- `x86_64-apple-darwin`
- `aarch64-apple-darwin`
- Windows:
- `x86_64-pc-windows-msvc`
- `aarch64-pc-windows-msvc`
The Linux binaries, and the `.deb` package built from them, are statically
linked against musl. They have no runtime dependencies: they run on any Linux
distribution and any glibc version, with no system packages to install.
## Requirements
The official binaries do not require these dependencies. They are needed only
to build termscp from source, for example with `cargo install 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>.
+28
View File
@@ -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, GCS, 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).
+47
View File
@@ -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);
})();
+39
View File
@@ -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();
}
});
}
})();
+2609
View File
File diff suppressed because one or more lines are too long
+13
View File
@@ -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/GCS/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/GCS/SMB/WebDAV">
<meta name="twitter:image" content="https://docs.termscp.rs/og_preview.jpg">
+31
View File
@@ -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)
+18
View File
@@ -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).
+29
View File
@@ -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.
+49
View File
@@ -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 |
+32
View File
@@ -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`

Some files were not shown because too many files have changed in this diff Show More