https://github.com/jossmoff/bookshelf

📚 A CLI tool for tracking your stories in the software development lifecycle
https://github.com/jossmoff/bookshelf

cli cli-tool python3 sdlc-tools tracking

Last synced: 3 months ago
JSON representation

📚 A CLI tool for tracking your stories in the software development lifecycle

• Host: GitHub
• URL: https://github.com/jossmoff/bookshelf
• Owner: jossmoff
• License: mit
• Created: 2023-10-20T16:21:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T00:42:01.000Z (about 2 years ago)
• Last Synced: 2026-01-04T00:01:48.165Z (6 months ago)
• Topics: cli, cli-tool, python3, sdlc-tools, tracking
• Language: Python
• Homepage: https://bookshelf.docs.joss.dev/
• Size: 1.68 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


  


  

  


  bookshelf

  






   📚 A CLI tool for tracking your stories in the software development lifecycle 





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



## 🔎 Tracking your productivity has never been easier



  


  

  


  




## 🚀 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                                                  |

|--------------------------------------------------------------------------|--------------------------------------------------------------|

| cancel   | Cancel the current chapter of a story on your bookshelf      |

| create   | Create a new story for your bookshelf                        |

| finish   | Finish writing a story on your bookshelf                     |

| info       | Displays the information for a given story on your bookshelf |

| ls           | List all the current stories on your bookshelf               |

| rm           | Remove a story from your bookshelf                           |

| start     | Start a new chapter for a story on your bookshelf            |

| stop       | Stop the current chapter of a story on your bookshelf        |

| tag      | Add a new tag a story on your bookshelf                      |

| untag    | 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.