Deep-Codes / wakatime-cli

👨🏽‍💻 Wakatime Stats right in Your Terminal! 🧬

🚀 Getting Started

👨🏽‍💻 Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• Wakatime Account

🕹 Installation

1. Get your Wakatime API Key from Here

2. Install Via npm

   npm install -g @deepcodes/wakatime-cli

🧬 Usage

• Options:

❯ wakatime-cli -h
Usage: wakatime-cli [options]

Options:
  -v, --vers              output the current version
  -k, --apiKey <type>     Enter Your Wakatime APIKEY
  -r, --remove            Remove Your saved API_KEY
  -l, --language          Coding Data of Languages in Last 7days
  -a, --all               All Time Since Today
  -g, --goals             Coding Goals Meet If Set Up
  -d, --dashboard <type>  Coding Dashboard of Specific Duration
  -h, --help              display help for command

• Save API-KEY

Copy Your Wakatime APIKEY:

This will Save your APIKEY.

 wakatime-cli -k <API_KEY>

If it's Saved it should show this:

Now that it's Saved You can get your Wakatime Stats Rightaway🚀

• Language Stats

Gives Stats of Language of last 7days

wakatime-cli -l

• Gives Cumulative Coding Time

wakatime-cli -a

• Dashboard

wakatime-cli -d <type>

<type> MUST be one of the following: -last_7_days -last_30_days -last_6_months -last_year

• Coding Goals

You must have Coding Goals Enabled For this:

wakatime-cli -g

• Remove the Saved API-KEY

wakatime-cli -r

More Feature Will be Added Soon. If you need some Feel Free to Open an Issue.

🏗Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📚 License

Distributed under the MIT License. See LICENSE for more information.

😇 Contact

Twitter - @DeepankarBhade

📖 Acknowledgements

• Wakatime
• Wakatime API