https://github.com/joypauls/scry

https://github.com/joypauls/scry

beginner-friendly cli configurable go golang terminal terminal-app

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/joypauls/scry
• Owner: joypauls
• License: apache-2.0
• Created: 2021-07-25T00:47:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-21T01:00:44.000Z (over 2 years ago)
• Last Synced: 2025-01-23T07:11:29.441Z (3 months ago)
• Topics: beginner-friendly, cli, configurable, go, golang, terminal, terminal-app
• Language: Go
• Homepage: https://joypauls.github.io/scry/
• Size: 1.84 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build Status](https://img.shields.io/github/workflow/status/joypauls/scry/Build)

![Latest Release](https://img.shields.io/github/v/release/joypauls/scry?include_prereleases)

[![Go Report](https://goreportcard.com/badge/github.com/joypauls/scry)](https://goreportcard.com/badge/github.com/joypauls/scry)

![Code Coverage](https://storage.googleapis.com/scry-build/code-coverage.svg)

![Go Version](https://img.shields.io/github/go-mod/go-version/joypauls/scry)

[![go.dev Reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/joypauls/scry)

> :warning: **WIP**: This is just a prototype, use at own risk!

# scry :crystal_ball:

A terminal-based file system explorer written in Go intuitive and snappy enough to keep up with your thoughts! Intended to exist in the space somewhere between the `ls` utility and a full-featured GUI file manager like Ranger to make some common tasks easy, quick, and fun.

This project makes heavy use of the wonderful [tcell](https://github.com/gdamore/tcell) Go package.

## Quick Start

Check out the documentation [website](joypauls.github.io/scry/) for the best experience, thank you!

## Configuration

Directory: `~/.scry/`

Config File: `~/.scry/config.yaml`

Favorites Store: `~/.scry/favorites.json`

## Dev Stuff

### Release a New Version

1. Create new tag with git like so: `git tag -a v -m ""`

2. Push the new tag `git push --tags`