See

Scan
Explore
Examine

---

Table of Contents

• Supported Operating Systems
• Summary
• Installing
  • For Linux and macOS
  • For Windows (WIP)
  • Quick Install
• Usage
• Uninstalling
• License
• Contributing

Supported Operating Systems

Summary

A simple file viewer with syntax highlighting for Linux, Windows and macOS.

Installing

The see tool is a command-line utility for viewing files in a user-friendly manner. Follow the steps below to install see on your supported operating systems. Ensure you have curl installed.

For Linux and macOS

1. Check if curl is installed

Run this command to check if curl is installed:

command -v curl >/dev/null 2>&1 && echo "YES" || echo "NO"

If the previous command outputs YES, then curl is installed and you can continue.

If it returns NO, then curl is not installed. In this case, please check how to install curl on your system and then repeat this step.

2. Download the Installer from my Official GitHub

Remove any outdated installer from your current working directory, if present:

[ -f ./install ] && rm -f ./install

Next, use curl to download the latest installer:

curl -O https://raw.githubusercontent.com/Henrisen/see/refs/heads/main/install

3. Run the Installer

You will need sudo permissions to run the installer. Use the following commands:

chmod +x ./install
sudo ./install

For Windows

1. Check if curl is installed

Run this command to check if curl is installed:

where curl >nul 2>&1 && echo YES || echo NO

If the previous command outputs YES, then curl is installed and you can continue.

If it returns NO, then curl is not installed. In this case, please check how to install curl on your system and then repeat this step.

2. Download the Installer from my Official GitHub

Remove any outdated installer from your current working directory, if present:

if exist .\install del /f .\install

Next, use curl to download the latest installer:

curl -O https://raw.githubusercontent.com/Henrisen/see/refs/heads/main/install.bat

3. Run the Installer

You will need sudo permissions to run the installer. Use the following commands:

.\install.bat

Quick Install

To install see with a single command:

Linux

command -v curl >/dev/null 2>&1 || { echo "curl is not installed. Please install curl and try again."; } && rm -f ./install && curl -s -O https://raw.githubusercontent.com/Henrisen/see/refs/heads/main/install && chmod +x ./install && sudo ./install

Windows

where curl >nul 2>&1 || (echo "curl is not installed. Please install curl and try again." & pause & exit /b) && (if exist installer.bat del /f installer.bat) & curl -s -O https://raw.githubusercontent.com/Henrisen/see/refs/heads/main/install.bat && (if exist install.bat call install.bat || (echo Failed to download installer.bat. & pause))

Usage

To use see, run it with the name of the file you want to open:

see example.sh

For real-time file updates, use the -f / --follow flag:

Currently only on Unix Version

see -f example.sh

For custom update intervals, use the -u / --update-interval flag (default is 125 ms):

Currently only on Unix Version

see -fu125 example.sh

Uninstalling

To uninstall see, use the following commands:

git clone https://github.com/Henrisen/see.git
cd see
sudo make uninstall

---

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for more details.

Contributing

Contributions to this project are welcome. Please fork the repository, make your changes, and submit a pull request. Ensure your code adheres to the project’s coding standards and includes relevant tests.

1. Fork the repository
2. Create a new branch for your feature
3. Commit your changes
4. Push your branch to your fork
5. Open a pull request
6. Wait for Approval