Categorygithub.com/nicklasfrahm/finder
modulepackage
0.0.0-20220205071840-9a54b63e5587
Repository: https://github.com/nicklasfrahm/finder.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
17
Dependents
1
Files
297 SLOC

# README

Finder 🔍

Finder is a tool to sort and organize your files.

Installation 🪄

Currently, we only support the installation via go directly as shown below.

# go >= 1.17
# Using `go get` to install binaries is deprecated.
# The version suffix is mandatory.
go install github.com/nicklasfrahm/cmd/finder@latest

# go < 1.17
go get github.com/nicklasfrahm/cmd/finder

License 📄

This project is and will always be licensed under the terms of the MIT license.

# Packages

No description provided by the author

# Functions

CreateSchema sets up the database tables to store the index of files and folders and additional application state.
FolderSize returns the size of the specified folder.
Index builds an index of all files and folders in the specified directory.
IndexFile indexes a file for a given IndexJob.
NewFile creates a new File instance.
ProcessFileStream extracts file attributes while only reading the file in once.
Resume attempts to resume an indexing operation.

# Structs

File represents an indexed file or folder in the file system.
IndexJob represents a job to index a file or folder.