Scry CLI
The terminal-based file system explorer and CLI tool that keeps up with your thoughts
Documentation
Welcome, happy to see you! While this project solidifies, feel free to head over to the project page and open an issue with any questions or requests. Happy hacking!
Get Started
Installation via Binary
Right now, the binaries are not being built automatically. Our advice would be to go straight to the source for now if you’re looking to experiment with the project. If you still want to use the pre-built releases, see which are available on the releases page.
M1 Mac:
wget https://github.com/joypauls/scry/releases/download/v0.0.1/scry-darwin-arm64.tar.gz
tar -xvzf scry-darwin-arm64.tar.gz
sudo mv scry-darwin-arm64 /usr/local/bin/scry
Confirm your installation with scry -v
Build from Source
-
Clone the repository
git clone https://github.com/joypauls/scry.git - Build the project
make build- By default, it will compile to
<repo>/bin/scry
- By default, it will compile to
- Check that it worked with
<repo>/bin/scry -v
Usage
Command Line Interface
Simply use scry to get started, or pass a path argument (scry /some/place/cool) like the classic ls program if you’re feeling spicy.
Take a look at scry --help for more options.
Basic
| Key | Description | Alternative |
|---|---|---|
| Up Arrow | Scroll through directory | W |
| Down Arrow | Scroll through directory | S |
| Left Arrow | Scroll through directory | A |
| Right Arrow | Scroll through directory | D |
| Q | Exit | ESC |
Additional Stuff
Compatibility
The only currently supported OS (that is, confirmed by user testing… probably will still work on many others!) is Darwin. However, you will likely be able to build from source on your machine without issue if you are setup for Go development, see Build From Source.
Keep in mind this could also depend on which terminal emulator you are using. If you see problems running this on your OS/terminal, let me know.
Customization
Use the .config/scry/config.yaml file. Look at the parser for the currently implemented features (we are actively adding to these).
Developers
Check out the project on GitHub!
Support and Bugs
A bug? In my code?!?
Just kidding 😊 Thank you for trying scry out! Feedback from actual real world testing is huge and we really appreciate it. Please head over to the project page on Github and open an issue and let me know how I can help or what problems you’re seeing!