Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nyaa8/codestats.nvim

🥬 A simple neovim plugin for CodeStats, the free stats tracking service for programmers.
https://github.com/nyaa8/codestats.nvim

Last synced: about 2 months ago
JSON representation

🥬 A simple neovim plugin for CodeStats, the free stats tracking service for programmers.

Awesome Lists containing this project

README

        

🥬 codestats.nvim
=================

A simple [neovim](https://neovim.io) plugin for [Code::Stats](https://codestats.net).

## Features

- no need for Python, Lua is bundled with neovim!
- compatible with [codestats-fish](https://github.com/nyaa8/codestats-fish) and [codestats-zsh](https://gitlab.com/code-stats/code-stats-zsh) (`CODESTATS_API_KEY`)

## Requirements

- cURL
- neovim 0.5 or newer

## Installation
### [vim-plug](https://github.com/junegunn/vim-plug)

```viml
Plug 'nyaa8/codestats.nvim'
```

### [vundle](https://github.com/VundleVim/Vundle.vim)

```viml
Plugin 'nyaa8/codestats.nvim'
```

### [vim-packager](https://github.com/kristijanhusak/vim-packager)

```viml
call packager#add('nyaa8/codestats.nvim')
```

### [dein](https://github.com/Shougo/dein.vim)

```viml
call dein#add('nyaa8/codestats.nvim')
```

## Configuration

Set the `CODESTATS_API_KEY` environment variable to your CodeStats token.

### Fish

```sh
set -Ux "SFMyNTY.OEotWWdnPT0jI01qaz0.X0wVEZquh8Ogau1iTtBihYqqL71FD8N6p5ChQiIpaxQ"
```

### Zsh

```sh
echo "export CODESTATS_API_KEY=SFMyNTY.OEotWWdnPT0jI01qaz0.X0wVEZquh8Ogau1iTtBihYqqL71FD8N6p5ChQiIpaxQ" >> ~/.zshenv
```

### Bash

```sh
echo "export CODESTATS_API_KEY=SFMyNTY.OEotWWdnPT0jI01qaz0.X0wVEZquh8Ogau1iTtBihYqqL71FD8N6p5ChQiIpaxQ" >> ~/.bash_profile
```

You can also set `CODESTATS_API_URL` if you want to use a different instance, eg.
```sh
set -Ux CODESTATS_API_URL "https://beta.codestats.net/api"
```