superfile Documentation

File: README.md Copy Chapter

Demo Copy Chapter

Content Copy Chapter

• Demo
• Content
• Installation
  • macOS and Linux
  • Windows
    • Powershell
    • Winget
    • Scoop
  • More installation methods
• Build
  • For macOS/Linux
  • For Windows
• Start superfile
• Supported Systems
• Tutorial
• Plugins
• Themes
• Hotkeys
• Notes
• Troubleshooting
• Uninstalling
  • macOS and Linux
  • Windows
• Contributing
• Thanks
  • Support
  • Core maintainer
  • Contributors
  • Powered by
  • Star History
• ༼ つ ◕_◕ ༽つ Please share.

Installation Copy Chapter

macOS and Linux Copy Section

bash -c "$(curl -sLo- https://superfile.dev/install.sh)"

If you want to inspect the script, see : install.sh

Windows Copy Section

Powershell

powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/install.ps1'))"

If you want to inspect the script, see : install.ps1

[Winget](https://winget.run/)

winget install --id yorukot.superfile

[Scoop](https://scoop.sh/)

scoop install superfile

More installation methods Copy Section

Click me to check on how to install

Build Copy Chapter

You can build the source code yourself by using these steps:

Requirements

• golang

Build Steps

Clone this repository using the following command:

git clone https://github.com/yorukot/superfile.git --depth=1

Enter the downloaded directory:

cd superfile

For macOS/Linux Copy Section

Run the build.sh file:

./build.sh

Add the binary file to your $PATH, e.g., in /usr/local/bin:

sudo mv ./bin/spf /usr/local/bin

For Windows Copy Section

go build -o bin/spf.exe

Edit System Environment Variables and add superfile repo's bin directory to your PATH

Start superfile Copy Chapter

spf

Supported Systems Copy Chapter

• [x] Linux
• [x] macOS
• [x] Windows (Not fully supported yet)

Tutorial Copy Chapter

After you install superfile, you can go here to briefly understand how to use superfile!

Plugins Copy Chapter

Click me to the plugins wiki

Themes Copy Chapter

Click me to the theme wiki

Hotkeys Copy Chapter

[!WARNING] If you are vim/nvim user please change your default hotkeys config to vim version!

Click me to see the hotkey wiki

Notes Copy Chapter

We have an auto update functionality, that fetches superfile's latest released version from github (if last timestamp of last version check was less than 24 hours) and prints a prompt to user, if there is a newer version available.

You can turn this off, by setting auto_check_update to false in superfile config. Click me to see the config wiki

Troubleshooting Copy Chapter

Click me to see common problem fix

Uninstalling Copy Chapter

macOS and Linux Copy Section

bash -c "$(curl -sLo- https://superfile.dev/uninstall.sh)"

If you want to inspect the script, see : uninstall.sh

Windows Copy Section

To uninstall superfile on Windows, use this powershell script.

powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.dev/uninstall.ps1'))"

Contributing Copy Chapter

If you want to contribute please follow the contribution guide

Click me to see changelog

Thanks Copy Chapter

Support Copy Section

• a Star on my GitHub repository would be nice 🌟
• You can buy a coffee for me 💖

Core maintainer Copy Section

We welcome anyone who wants to become a core maintainer. Feel free to reach out!

• @yorukot - Original author and maintainer
• @lazysegtree - Core maintainer

Contributors Copy Section

Thanks to all the contributors for making this project even greater!

Powered by Copy Section

Thanks to JetBrains team for providing open-source licenses to support the maintenance of superfile.

Star History Copy Section

THANKS FOR All OF YOUR STARS! Your stars are my motivation to keep updating!

File: testsuite/docs/tmux.md Copy Chapter

Overview

This is to document the behaviour of tmux, and how could we use it in testsuite

Tmux concepts and working info

• Tmux creates a main server process, and one new process for each session.

• -s and -n for window naming.

• We have prefix keys to send commands to tmux.

Sample usage with spf

Sending keys to termux and controlling from outside. Copy Chapter

Knowledge sharing

• tmux new 'spf' - Run spf in tmux
• tmux attach -t <session_name> attach to an existing session. You can have two windows duplicating same behaviour.
• tmux kill-session -t <session_name> kill session
• Ctrl+B+: - Enter commands
• Ctrl+B+D - Detach from session
• :source ~/.tmux.conf - Change the config of running server
• We have already a wrapper library for termux in python !!!!!
• How to send key press/tmux commands to the process ?

References

• https://github.com/tmux/tmux/wiki/Getting-Started
• https://tao-of-tmux.readthedocs.io/en/latest/manuscript/10-scripting.html#controlling-tmux-send-keys
• https://github.com/tmux-python/libtmux