Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TermKeys

Safer, faster terminal shortcuts by BLCCoreStudio

Version Status Platform License

A Linux terminal shortcut manager for Fish shell and GNU Nano with automatic backups, conflict detection, and safe restore.

Download v0.1.0 · Security · Changelog · Contributing


TermKeys is a lightweight Linux CLI tool for managing useful terminal keyboard shortcuts and key bindings without hand-editing shell or editor configuration files. The current alpha release supports Fish shell and GNU Nano, with configuration backups, conflict detection, safe writes, diagnostics, uninstall, and restore workflows built around local configuration safety.

Why TermKeys

  • Add useful terminal shortcuts without manually editing shell or editor configuration files
  • Fish shell and GNU Nano integration in the current release
  • Automatic original-configuration backups before managed changes
  • Existing shortcut conflict detection to avoid silently replacing a key binding
  • Safe uninstall and original-configuration restore
  • Status inspection and doctor diagnostics for managed configuration
  • No sudo requirement, telemetry, intentional network communication, or credential storage in 0.1.0

Install

TermKeys v0.1.0 is an alpha / pre-release for Linux x86_64.

Recommended: inspect the public installer, then run it

The public installer discovers the newest published TermKeys Linux x86_64 release on GitHub, downloads the release archive and its SHA256SUMS.txt, verifies the archive before extraction, and installs only the verified termkeys binary to ~/.local/bin/termkeys.

It does not use sudo, modify TermKeys configuration/backups, or send telemetry. Its network access is limited to GitHub release discovery and release-file downloads.

curl -fL https://raw.githubusercontent.com/BLCCoreStudio/TermKeys/main/scripts/install.sh -o termkeys-install.sh
cat termkeys-install.sh
sh termkeys-install.sh
rm termkeys-install.sh

A no-change check is also available:

sh scripts/install.sh --dry-run

If ~/.local/bin is not already in your PATH, the installer prints the command needed to add it.

Manual release download

Download both files from the official release:

Release page: TermKeys v0.1.0

Verify before extracting:

sha256sum -c SHA256SUMS.txt

Then extract:

tar -xzf TermKeys-v0.1.0-linux-x86_64.tar.gz

Uninstall the public binary

The public uninstaller removes only ~/.local/bin/termkeys. It intentionally leaves TermKeys configuration, backups, shell/editor settings, and other user data untouched.

curl -fL https://raw.githubusercontent.com/BLCCoreStudio/TermKeys/main/scripts/uninstall.sh -o termkeys-uninstall.sh
cat termkeys-uninstall.sh
sh termkeys-uninstall.sh
rm termkeys-uninstall.sh

What the Current Shortcut Does

TermKeys 0.1.0 currently manages an F12 shortcut while providing the backup, conflict-detection, ownership, diagnostics, uninstall, and restore workflow around that change.

Fish shell

Pressing F12:

  • clears the current command line
  • clears the terminal screen

GNU Nano

Pressing F12 clears the current buffer using Nano's cut-buffer behavior.

The product is not intended to be only an F12 script: its core value is safer local shortcut and shell/editor configuration management around managed key bindings.

Features

TermKeys v0.1.0 currently provides:

  • Fish shell integration
  • GNU Nano integration
  • F12 quick-clear shortcut
  • Automatic configuration backups
  • Existing shortcut conflict detection
  • Safe configuration writes
  • Status inspection
  • Doctor diagnostics
  • Safe uninstall
  • Original configuration restore
  • Safe restore workflow
  • Managed configuration ownership checks
  • Atomic configuration writes
  • Existing file permission preservation
  • Restore path validation
  • status command
  • doctor command
  • plan command
  • SHA-256 release verification

Safety Model

TermKeys modifies local shell and editor configuration files, so configuration safety is treated as a core product concern.

Security-sensitive behavior includes:

  • automatic configuration backups
  • restore operations and restore path validation
  • existing shortcut conflict detection
  • managed configuration ownership checks
  • atomic configuration writes
  • existing file permission preservation
  • installation and uninstall behavior

TermKeys is designed to refuse unsafe configuration changes when ownership or restore safety cannot be established.

Additional release security properties for 0.1.0:

  • No sudo requirement
  • No telemetry
  • No intentional network communication by the installed TermKeys application
  • No credential storage
  • Refuses unsafe configuration overwrites
  • Official release archive accompanied by SHA-256 verification data

The public installer itself only contacts GitHub to discover and download official release files before local installation.

See SECURITY.md for vulnerability reporting and security scope.

Platform Support

Platform Status
Linux x86_64 Official 0.1.0 pre-release · verified on Debian 11 / glibc 2.31
Windows Not currently officially supported
macOS Not currently officially supported

Public Repository Model

TermKeys uses a proprietary binary distribution model. The complete implementation is maintained privately by BLCCoreStudio.

This public repository is the official location for intentionally published TermKeys material, including:

  • official releases and release information
  • public installer and uninstaller tooling
  • documentation and changelog history
  • security information and vulnerability-reporting guidance
  • contribution resources
  • issue, compatibility, and usability feedback

Private development areas include:

  • application source code
  • configuration management implementation
  • backup and restore implementation
  • conflict detection logic
  • internal tests
  • build tooling
  • release engineering
  • proprietary product logic

Public visibility of this repository does not make the complete TermKeys implementation open source. The public Shell scripts are limited distribution helpers for the published binary release; they are not the proprietary TermKeys application implementation.

The public repository validation workflow checks required public files, enforces the tracked-file whitelist, rejects sensitive file types, limits scripts/ to the reviewed public installer/uninstaller, and blocks designated private implementation paths.

Contributing

Community contributions may include documentation improvements, typo and wording fixes, English and Turkish translations, usage examples, compatibility reports, bug reports, feature requests, usability suggestions, and improvements to the public installer/uninstaller tooling.

Read CONTRIBUTING.md before opening a pull request.

Do not report suspected security vulnerabilities through public issues; follow SECURITY.md.

Release History

See CHANGELOG.md.

Rights and Licensing

TermKeys is proprietary software developed and maintained by BLCCoreStudio.

Permission to use officially published release binaries is governed by the repository LICENSE. Public visibility of selected repository files does not make the complete implementation open source.


Built by BLCCoreStudio.

Release · Security · Changelog · License

About

Linux terminal shortcut management with safe backups, conflict checks, and recovery.

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages