https://github.com/rumpl/c

Add comments on any file or folder.
https://github.com/rumpl/c

Last synced: about 1 year ago
JSON representation

Add comments on any file or folder.

• Host: GitHub
• URL: https://github.com/rumpl/c
• Owner: rumpl
• License: mit
• Created: 2012-07-16T21:58:14.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2021-04-07T00:07:03.000Z (over 5 years ago)
• Last Synced: 2025-05-12T15:37:10.198Z (about 1 year ago)
• Language: JavaScript
• Size: 49.4 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

          
# c

## Project information

Write, view, edit and delete comments on files and directories, all from the command line.

Authored by [Djordje Lukic](lukic.djordje@gmail.com). 


Original idea by [Jonovono](https://github.com/Jonovono/c).

---

## Installation

Install the module globally with `npm install c -g`.

---

## Commands

    Usage: c [-l  | list ]

             [-rm | remove ]

             [-s  | set  ]

             [-h  | help]

             [-v  | version]

    Options:

      list    | -l     Lists all the comments for the specified directory.

      set     | -s     Sets or overwrites a new comment for the file|directory.

      remove  | -rm    Deletes the comment for the file|directory.

      help    | -h     Shows the help menu.

      version | -v     States the version.

---

## Usage

### `-s` or `set` **and** `-l` or `list`

![Setting and listing comments gif](http://raw.githubusercontent.com/rumpl/c/master/resources/ListandSet.gif)

#### **Example:**

    $ c set . "What a great utility!"

    $ c list .

#### **Output:**

    "What a great utility!" was applied to "." successfully.

    ./           What a great utility!

    ../

    SomeDir/

    SomeFile.ext

#### **Example:**

    $ c -s someDir "Another comment"

    $ c -l .

#### **Output:**

    "Another comment" was applied to "someDir" successfully.

    ./           What a great utility!

    ../

    SomeDir/     Another comment

    SomeFile.ext

---

### `-rm` or `remove`

![Removing comments gif](http://raw.githubusercontent.com/rumpl/c/master/resources/Deleting.gif)

#### **Example:**

    $ c remove someDir

    $ c list .

#### **Output:**

    someDir comment was deleted successfully.

    ./           What a great utility!

    ../

    SomeDir/

    SomeFile.ext

---

### `-v` or `version` **and** `-h` or `help`

![Alternative operations gif](http://raw.githubusercontent.com/rumpl/c/master/resources/other.gif)

---

### Operating in child and parent directories

![Complex usage demo gif](http://raw.githubusercontent.com/rumpl/c/master/resources/NestedWorking.gif)

## Releasing

To release a new version of `c` simply do:

```

$ git tag -a vVERSION -m "Version VERSION"

# For example:

$ git tag -a v1.0.0 -m "Version 1.0.0"

```

This will create a new release on github and publish the package on npm

## License

MIT: http://rumpl.mit-license.org