Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pluveto/ankiterm
A command line anki reviewer based on AnkiConnect
https://github.com/pluveto/ankiterm
Last synced: 4 days ago
JSON representation
A command line anki reviewer based on AnkiConnect
- Host: GitHub
- URL: https://github.com/pluveto/ankiterm
- Owner: pluveto
- License: mit
- Created: 2023-11-07T10:46:31.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-09T04:01:47.000Z (about 1 year ago)
- Last Synced: 2024-11-02T07:33:21.625Z (11 days ago)
- Language: Go
- Homepage:
- Size: 83 KB
- Stars: 17
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ankiterm
Ankiterm is a cli anki review tool.
## Table of Contents
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Demo
## Installation
To install AnkiTerm, follow these steps:
1. Clone the repository: `git clone https://github.com/pluveto/ankiterm.git`
2. Navigate to the project directory: `cd ankiterm`
3. Build the executable: `make`
4. Install AnkiTerm: `make install` (`INSTALL_DIR` can be specified, default is `/usr/local/bin`)
## Usage
AnkiTerm can be used as follows:
```shell
ankiterm "Deck Name"
```
Options:
- `-r, --reviewer`: Reviewer name. Different reviewer will provide different review interaction strategy.
- `stream`: The default reviewer. History cards will apprear in a operation stream.
- `oneline`: Cards will apprear in a single line.
Examples:
```shell
ankiterm vocabs -r oneline
```
## Contributing
Contributions are welcome! Here's how you can contribute to the project:
1. Fork the repository.
2. Create a new branch: `git checkout -b feature/your-feature-name`
3. Make your changes and commit them: `git commit -am 'feat: add some feature'`
4. Push the branch to your forked repository: `git push origin feature/your-feature-name`
5. Open a pull request.
Please ensure that your code follows the project's coding style and includes appropriate tests.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.