https://github.com/xixixao/skim

skim command for unix shells
https://github.com/xixixao/skim

Last synced: 19 days ago
JSON representation

skim command for unix shells

• Host: GitHub
• URL: https://github.com/xixixao/skim
• Owner: xixixao
• Created: 2013-02-27T23:20:13.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-02-28T03:31:45.000Z (almost 12 years ago)
• Last Synced: 2024-11-14T20:47:45.745Z (3 months ago)
• Language: CoffeeScript
• Homepage:
• Size: 141 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
skim

===

**skim** command for unix environments.

- Non-unix way to do unix.

- Breadth-first search.

- Simplified find.

- Sensible output.

- When you don't have Sublime open.

## Installation

You will need `Node.js` version at least 0.6.x

Copy the file `skim` to your preferred `bin` folder.

Install `commander`.js to your `bin` folder (either with `npm install commander` or by copying from here).

## Examples

```bash

$ skim looking_for.txt

```

```bash

$ skim where/ looking_for.txt

```

Note the `/` at the end of folder name is important.

```bash

$ skim ".*\.js"

```

```bash

$ skim -d "\w+_\w+\"

```

```bash

$ skim -m 3 -n 1 fast.coffee

```

## Documentation

```bash

$ skim --help

  Usage: skim [options] [where] 

  Options:

    -h, --help          output usage information

    -V, --version       output the version number

    -w, --where   Path to start search in

    -m, --max        Maximum depth to search into, 1 is minimum

    -n, --number     Return the first n results and stops

    -t, --top           Return the first result and all results at that depth

    -d, --dir           Look for directories only

    -f, --file          Look for files only

By default, tries to find all results. Search location

can also be specified in the first argument, but named

folders must end with '/' or '\'.

```