https://github.com/deep-codes/wakatime-cli
👨🏽💻 Wakatime Stats right in Your Terminal! 🧬
https://github.com/deep-codes/wakatime-cli
node-cli typescript wakatime wakatime-api wakatime-cli
Last synced: 5 months ago
JSON representation
👨🏽💻 Wakatime Stats right in Your Terminal! 🧬
- Host: GitHub
- URL: https://github.com/deep-codes/wakatime-cli
- Owner: Deep-Codes
- Created: 2020-11-25T13:11:37.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-28T03:50:36.000Z (almost 5 years ago)
- Last Synced: 2025-05-05T19:19:32.963Z (5 months ago)
- Topics: node-cli, typescript, wakatime, wakatime-api, wakatime-cli
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@deepcodes/wakatime-cli
- Size: 551 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 🚀 Getting Started
### 👨🏽💻 Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- npm
```sh
npm install npm@latest -g
```
- Wakatime Account
### 🕹 Installation
1. Get your Wakatime API Key from [Here](https://wakatime.com/settings/account)
2. Install Via `npm`
```sh
npm install -g @deepcodes/wakatime-cli
```
## 🧬 Usage
- #### Options:
```sh
❯ wakatime-cli -h
Usage: wakatime-cli [options]
Options:
-v, --vers output the current version
-k, --apiKey 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 Coding Dashboard of Specific Duration
-h, --help display help for command
```
- #### Save API-KEY
Copy Your `Wakatime APIKEY`:
This will Save your APIKEY.
```sh
wakatime-cli -k
```
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
```sh
wakatime-cli -l
```
- #### Gives Cumulative Coding Time
```sh
wakatime-cli -a
```
- #### Dashboard
```
wakatime-cli -d
```
`` 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
```sh
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](https://twitter.com/DeepankarBhade)
## 📖 Acknowledgements
- [Wakatime](https://wakatime.com/dashboard)
- [Wakatime API](https://wakatime.com/developers)