Nascent Political Miscreant
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    ideapublic

    idea

    $ idea

    Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads

    A lightweight CLI tool and module for keeping ideas in a safe place quick and easy.

    ☁️ Installation

    You can install the package globally and use it as command line tool:

    # Using npm 
    npm install --global idea
     
    # Using yarn 
    yarn global add idea

    Then, run idea --help and see what the CLI tool can do.

    $ idea --help
    idea help
    usage: idea [command] <idea|filter|id>
    
    A lightweight CLI tool and module for keeping your ideas in a safe place quick and easy.
    
    [command]
      create <idea>           Creates and saves a new idea. Example: `idea create "Implement something very cool"`
      list                    Lists all ideas. Example: `idea list`
      filter <filter>         Lists filtered ideas. Example: `idea filter '{"state": "SOLVED"}'`
      solve <id>              Solves an idea. Example `idea solve 1`
      help                    Prints this help.
    
    Documentation can be found at https://github.com/IonicaBizau/idea
    

    📋 Example

    Here is an example how to use this package as library. To install it locally, as library, you can do that using npm (or yarn):

    # Using npm 
    npm install --save idea
     
    # Using yarn 
    yarn add idea
    // Dependencies
    var Idea = require("idea");
     
    // Initialize the idea object
    var idea = new Idea("./ideas.json", err => {
        if (err) throw err;
        idea.create("Implement something cool.", err => {
            if (err) throw err;
        });
    });

    ❓ Get Help

    There are few ways to get help:

    1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

    2. For bug reports and feature requests, open issues. 🐛

    3. For direct and quick help, you can use Codementor. 🚀

    📝 Documentation

    For full API reference, see the DOCUMENTATION.md file.

    😋 How to contribute

    Have an idea? Found a bug? See how to contribute.

    💖 Support my projects

    I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

    However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

    • Starring and sharing the projects you like 🚀

    • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

    • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

    • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

    • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

    Thanks! ❤️

    📜 License

    MIT © Ionică Bizău

    Keywords

    install

    npm i idea

    Downloadsweekly downloads

    7

    version

    2.0.9

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar