Skip to content

Jackson-Wozniak/DevNote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Version License Downloads Issues

📚 Table of Contents

  1. Installation Guide
  2. Using in Your Workflow
  3. Future Roadmap
  4. Version History

💻 Installation Guide

Installing the DevNote CLI

  1. Download the release by going to the Github Release page for your platform and version:
    • https://github.com/Jackson-Wozniak/DevNote/releases
  2. Extract the contents of the ZIP file into a folder on your machine:
    • Windows: C:\Users\user\DevNote
    • Linux/macOS: ~/DevNote
  3. Add DevNote to your Path. This allows you to run DevNote command from anywhere
    • Windows:
      • Open Edit the system environment variables from Start
      • Click Environment Variables...
      • In User Variables, click Path -> Edit -> New and enter the release folder path
    • Linux/macOS:
      • Add the folder to your PATH in your shell configuration (~/.bashrc or ~.zshrc): export PATH="$HOME/DevNote:$PATH"
  4. Run DevNote -v and you should see the version of your installed release

💼 Using in Your Workflow


📋 Future Roadmap

The following features are possibilities for future updates:

  • SQLite-based database (replacing JSON data files)
  • Identifiers for each entry
  • Enhanced list options
    • search by tag, id, date, date range
    • list x number of entries, sorted by most-recent date
  • Delete by id
  • Delete tags
  • Configuration options
    • default list command return count
    • JSON vs. SQLite
    • export data files to markdown

📆 Version History

  • v1.0.0 [11/11/2025] - Initial release
  • v1.0.1 [11/11/2025] - Fixed file path bug causing crashes

About

DevNote is a lightweight CLI tool to quickly store and retrieve snippets of information while coding. Add it to your workflow to easily bookmark tidbits of information, such as common bugs fixes

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors