Giter Club home page Giter Club logo

whatthedot's Introduction

What The Dot

A tool for identifying dotfiles in a home directory.

Usage

Run wtd.py to scan your home directory. Pass -c to force colourful output if your terminal supports it. You can set an alternative start directory with -r <new root>. Only files that exist will be shown, use -a to skip existence checks.

The default output format is a tree of files, though you can list by program with -p (optionally with one or more program names to filter the output).

Known files

The list of identified files is stored in known.json. This is a single JSON object structured to match an actual home directory. Keys are file or directory names, where directory contents are provided as a nested dictionary.

The format for an individual file may look like the following:

filename: {"program": program, "type": type, "files": {directory contents}]

All fields are optional, though directories must specify a nested files object (it can be empty).

For files used by multiple programs, specify a programs attribute with a list of names instead.

File types

Type Description Examples
cache temporary, cache or lock files .gksu.lock, .thumbnails
config user-configurable settings file .bashrc, .vimrc
history shell or interpreter history .bash_history, .mysql_history
install program files or binaries .gem, .steam
key auth files, private keys/keyrings .gnupg/pubring.kbx, .ssh/id_rsa
log debug or installation log files .irssi/away.log, .pip/pip.log
session auto-generated cookies/keys .pulse-cookie, .Xauthority

Conditions for inclusion

Entries in known.json should represent default locations for files created or read by other programs. The program does not necessarily have to use them by default (for example, a log file may be created at the given location if logging is enabled by the user), though custom locations should not be included (for example, if a command-line switch to set the file path is used). This includes conventional locations that a program does not know about by default.

whatthedot's People

Contributors

terrance avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.