https://github.com/ShenQingchuan/meditate
Aim to be a powerful slack-off CLI application.
https://github.com/ShenQingchuan/meditate
Last synced: 3 months ago
JSON representation
Aim to be a powerful slack-off CLI application.
- Host: GitHub
- URL: https://github.com/ShenQingchuan/meditate
- Owner: ShenQingchuan
- License: mit
- Created: 2021-11-19T04:19:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-01T12:41:01.000Z (over 1 year ago)
- Last Synced: 2024-11-02T02:02:59.414Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 406 KB
- Stars: 37
- Watchers: 3
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# meditate
a powerful slack-off CLI application.
[](https://npmjs.org/package/@slackoff/meditate)
[](https://oclif.io)
[](https://www.npmjs.com/package/@slackoff/meditate)
[](https://www.npmjs.com/package/@slackoff/meditate)
[](https://github.com/ShenQingchuan/meditate/blob/master/package.json)
# Preview
## Reading book
**Read view**
```
med book ~/Downloads/天才基本法.txt
```
You can also input numbers to jump with multiple pages change. (After you input these numbers, you can use `j` or `k` to jump to the next/previous page.)
Here I'll go on typing a `j` as demo:
**Search view**
```bash
med book ~/Downloads/金凤华庭.txt -s 未梳洗
```
You can even add an alias for your book:
## Wordle game
## Chinese poem · 一言
## Game · 2048
## Days
* [meditate](#meditate)
* [Preview](#preview)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g @slackoff/meditate
$ med COMMAND
running command...
$ med (--version)
@slackoff/meditate/2.3.0 win32-x64 node-v16.17.0
$ med --help [COMMAND]
USAGE
$ med COMMAND
...
```
# Commands
* [`med 2048`](#med-2048)
* [`med book [FILEPATH]`](#med-book-filepath)
* [`med book alias [ALIASNAME] [ALIASPATH]`](#med-book-alias-aliasname-aliaspath)
* [`med cnpoem`](#med-cnpoem)
* [`med days`](#med-days)
* [`med help [COMMAND]`](#med-help-command)
* [`med init`](#med-init)
* [`med wordle`](#med-wordle)
## `med 2048`
2048 Game in terminal
```
USAGE
$ med 2048
DESCRIPTION
2048 Game in terminal
```
_See code: [dist/commands/2048/index.ts](https://github.com/ShenQingchuan/meditate/blob/v2.3.0/dist/commands/2048/index.ts)_
## `med book [FILEPATH]`
Read a novel, enjoy a story...
```
USAGE
$ med book [FILEPATH] [-h] [-r] [-s ] [-j ]
FLAGS
-h, --help help information for book reading command.
-j, --jump= assign a position to start reading.
-r, --restart restart reading progress of a given book.
-s, --search= open searching view to locate given words.
DESCRIPTION
Read a novel, enjoy a story...
```
_See code: [dist/commands/book/index.ts](https://github.com/ShenQingchuan/meditate/blob/v2.3.0/dist/commands/book/index.ts)_
## `med book alias [ALIASNAME] [ALIASPATH]`
Set an alias for your book
```
USAGE
$ med book alias [ALIASNAME] [ALIASPATH] [-l]
FLAGS
-l, --list list all aliases
DESCRIPTION
Set an alias for your book
```
## `med cnpoem`
get one sentence of a Chinese poem
```
USAGE
$ med cnpoem
DESCRIPTION
get one sentence of a Chinese poem
```
_See code: [dist/commands/cnpoem/index.ts](https://github.com/ShenQingchuan/meditate/blob/v2.3.0/dist/commands/cnpoem/index.ts)_
## `med days`
Memorize your important days.
```
USAGE
$ med days [-d -n ]
FLAGS
-d, --desc= description of a memo date
-n, --new= create a new memorize day
DESCRIPTION
Memorize your important days.
Input date format could be any valid connector: dot(.)、slash(/) and dash(-)
EXAMPLES
$ med days
$ med days -n 2022.2.1 -d "Spring Festival"
```
_See code: [dist/commands/days/index.ts](https://github.com/ShenQingchuan/meditate/blob/v2.3.0/dist/commands/days/index.ts)_
## `med help [COMMAND]`
Display help for med.
```
USAGE
$ med help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for med.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.14/src/commands/help.ts)_
## `med init`
initialize meditate application data.
```
USAGE
$ med init [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
initialize meditate application data.
```
_See code: [dist/commands/init/index.ts](https://github.com/ShenQingchuan/meditate/blob/v2.3.0/dist/commands/init/index.ts)_
## `med wordle`
an interesting word guessing game.
```
USAGE
$ med wordle [-h]
FLAGS
-h, --history print current month's game record
DESCRIPTION
an interesting word guessing game.
```
_See code: [dist/commands/wordle/index.ts](https://github.com/ShenQingchuan/meditate/blob/v2.3.0/dist/commands/wordle/index.ts)_