bookshelf-cli 0.4.0
📚 A CLI tool for tracking your stories in the SDLC.
Requires Python: >=3.10

<h1 align="center">
  <br>
  <img src="docs/src/assets/bookshelf.png" width="200px"/>
  <br>
  bookshelf
  <br>
</h1>

<h4 align="center">
   📚 A CLI tool for tracking your stories in the software development lifecycle 
</h4>


<p align="center">

  <a href="https://codecov.io/gh/jossmoff/bookshelf">
    <img src="https://codecov.io/gh/jossmoff/bookshelf/branch/main/graph/badge.svg" />
  </a>

  <a href="https://github.com/jossmoff/bookshelf/issues">
    <img src="https://img.shields.io/github/issues/jossmoff/bookshelf.svg">
  </a>

  <a href="https://github.com/jossmoff/bookshelf/pulls">
    <img src="https://img.shields.io/github/issues-pr/jossmoff/bookshelf.svg">
  </a>

  <a href="https://github.com/tronprotocol/jossmoff/bookshelf/graphs/contributors">
    <img src="https://img.shields.io/github/contributors/jossmoff/bookshelf.svg">
  </a>

  <a href="LICENSE">
    <img src="https://img.shields.io/github/license/jossmoff/bookshelf.svg">
  </a>
</p>

## 🔎 Tracking your productivity has never been easier
<div align="center">
  <br>
  <img src="docs/src/assets/example-terminal.png" width="60%"/>
  <br>
  <br>
</div>

## 🚀 Getting Started

### 🛠️ Installation
Use `pip` to install bookshelf:

```bash
pip install bookshelf
```

To optimally set up bookshelf, follow the [Getting Started guide in the documentation](https://bookshelf.docs.joss.dev/getting-started/installation/).

### 🧑‍💻 Usage
The documentation for bookshelf is available at [bookshelf.docs.joss.dev](https://bookshelf.docs.joss.dev/) and contains a detailed guide on how to use bookshelf.

To list available commands, either run `bookshelf` with no parameters or execute `bookshelf` help:
The base command for the `bookshelf` CLI.

#### Subcommands

| Name                                                                     | Description                                                  |
|--------------------------------------------------------------------------|--------------------------------------------------------------|
| <a href="https://bookshelf.docs.joss.dev/reference/cancel/">cancel</a>   | Cancel the current chapter of a story on your bookshelf      |
| <a href="https://bookshelf.docs.joss.dev/reference/create/">create</a>   | Create a new story for your bookshelf                        |
| <a href="https://bookshelf.docs.joss.dev/reference/finish/">finish  </a> | Finish writing a story on your bookshelf                     |
| <a href="https://bookshelf.docs.joss.dev/reference/info/">info   </a>    | Displays the information for a given story on your bookshelf |
| <a href="https://bookshelf.docs.joss.dev/reference/ls/">ls    </a>       | List all the current stories on your bookshelf               |
| <a href="https://bookshelf.docs.joss.dev/reference/rm/">rm    </a>       | Remove a story from your bookshelf                           |
| <a href="https://bookshelf.docs.joss.dev/reference/start/">start  </a>   | Start a new chapter for a story on your bookshelf            |
| <a href="https://bookshelf.docs.joss.dev/reference/stop/">stop    </a>   | Stop the current chapter of a story on your bookshelf        |
| <a href="https://bookshelf.docs.joss.dev/reference/create/">tag    </a>  | Add a new tag a story on your bookshelf                      |
| <a href="https://bookshelf.docs.joss.dev/reference/create/">untag   </a> | Remove a tag from a story on your bookshelf                  |

## 🤝 Contributing 

We're excited that you want to contribute to bookshelf. Your help and contributions are greatly appreciated!
Read the [contribution guidelines](CONTRIBUTING.md) to get started.

## 📜 Code of Conduct 

We value your contribution and participation in our community. To ensure a positive and inclusive environment for all, we have established a Code of Conduct.
Read the [Code of Conduct](CODE_OF_CONDUCT.md) to learn more.