Skip to content

Latest commit

 

History

History
316 lines (213 loc) · 7.55 KB

README.md

File metadata and controls

316 lines (213 loc) · 7.55 KB

golangci-lint release

🎲 jrp

Language:Go License:MIT Latest Release
Coverage Report
demo

ℹ️ About

jrp generates Japanese random phrases.
This tool uses WordNet Japan sqlite database file.

📟 CLI

You can generate and save the generated phrases to the history and manage them via the CLI.
Also, you can favorite the generated phrases and manage them.

💻 Usage

Available Subcommands:
  download,    dl,   d  📦 Download WordNet Japan sqlite database file from the official web site.
  generate,    gen,  g  ✨ Generate Japanese random phrases.
                           You can abbreviate "generate" sub command. ("jrp" and "jrp generate" are the same.)
  interactive, int,  i  💬 Generate Japanese random phrases interactively.
  history,     hist, h  📜 Manage the histories of the "generate" command.
  favorite,    fav,  f  ⭐ Favorite the histories of the "generate" command.
  unfavorite,  unf,  u  ❌ Unfavorite the favorited histories of the "generate" command.
  completion   comp, c  🔧 Generate the autocompletion script for the specified shell.
  version      ver,  v  🔖 Show the version of jrp.
  help                  🤝 Help for jrp.

Flags:
  -n, --number       🔢 number of phrases to generate (default 1, e.g. : 10)
  -p, --prefix       🔡 prefix of phrases to generate
  -s, --suffix       🔡 suffix of phrases to generate
  -d, --dry-run      🧪 generate phrases without saving as the histories
  -f, --format       📝 format of the output (default "table", e.g. : "plain")
  -i, --interactive  💬 generate Japanese random phrases interactively
  -t, --timeout      ⌛ timeout in seconds for the interactive mode (default 30, e.g. : 10)
  -h, --help         🤝 help for jrp
  -v, --version      🔖 version for jrp

Argument:
  number  🔢 number of phrases to generate (e.g. : 10)

💬 Interactive mode

demo_interactive

jrp can generate Japanese random phrases interactively.
You can favorite, save, skip, and exit interactively while generating phrases.

To use this mode, run either command below.

# Those commands below are equivalent.
# And they have their aliases. Please check the help message.
jrp interactive
# or
jrp --interactive
# or
jrp generate interactive
# or
jrp generate --interactive

Press either key below for your action.

  • u
    • Favorite, continue.
  • i
    • Favorite, exit.
  • j
    • Save, continue.
  • k
    • Save, exit.
  • m
    • Skip, continue.
  • other
    • Skip, exit.

🌍 Environments

📁 Connection string of WordNet Japan database

Default : $XDG_DATA_HOME/jrp/wnjpn.db or $HOME/.local/share/jrp/wnjpn.db

export JRP_WNJPN_DB=/path/to/your/directory/wnjpn.db

📁 Connection string of jrp database

Default : $XDG_DATA_HOME/jrp/jrp.db or $HOME/.local/share/jrp/jrp.db

export JRP_DB=/path/to/your/directory/jrp.db

🔧 Installation

🐭 Using go

go install github.com/yanosea/jrp/v2/app/presentation/cli/jrp@latest

🍺 Using homebrew

brew tap yanosea/tap
brew install yanosea/tap/jrp

📦 Download from release

Go to the Releases and download the latest binary for your platform.

✨ Update

🐭 Using go

Reinstall jrp!

go install github.com/yanosea/jrp/v2/app/presentation/cli/jrp@latest

🍺 Using homebrew

brew update
brew upgrade jrp

📦 Download from release

Download the latest binary from the Releases page and replace the old binary in your $PATH.

🧹 Uninstallation

🔧 Uninstall jrp

🐭 Using go
rm $GOPATH/bin/jrp
# maybe you have to execute with sudo
rm -fr $GOPATH/pkg/mod/github.com/yanosea/jrp*
🍺 Using homebrew
brew uninstall jrp
brew untap yanosea/tap/jrp
📦 Download from release

Remove the binary you downloaded and placed in your $PATH.

🗑️ Remove data files

If you've set jrp envs, please replace $HOME/.local/share/jrp with envs you've set.
These below commands are in the case of default. Ofcourse you can remove whole the directory.

💾 Remove WordNet Japan sqlite database file
rm $HOME/.local/share/jrp/wnjpn.db
💾 Remove jrp sqlite database file
rm $HOME/.local/share/jrp/jrp.db

🌐 API Server

jrp also provides RESTful API server that you can use to get Japanese random phrases.

💻 Usage

# If you installed with go, you can run the server with the command below.
jrp-server
# If you cloned the repository, you can run the server with the command below.
go run app/presentation/api/jrp-server/main.go
# Then, you can access the API server with the URL below.
curl http://localhost:8080/api/jrp

📚 API Documentation

Swagger documentation is available at: http://localhost:8080/swagger/index.html

Available Endpoints

Method Path Description
GET /api/jrp Get a generated Japanese random phrase

⚡ Caution

You have to download the WordNet Japan sqlite database file from WordNet Japan before running the server.

🌍 Environments

🚢 Port number

Default : 8080

export JRP_SERVER_PORT=8080

📁 Connection string of WordNet Japan database

Default : $XDG_DATA_HOME/jrp/wnjpn.db or $HOME/.local/share/jrp/wnjpn.db

export JRP_SERVER_WNJPN_DB=/path/to/your/directory/wnjpn.db

🔧 Installation

🐭 Using go

go install github.com/yanosea/jrp/v2/app/presentation/api/jrp-server@latest

🚀 With source code

git clone github.com/yanosea/jrp
cd jrp
go run app/presentation/api/jrp-server/main.go

✨ Update

🐭 Using go

Reinstall jrp-server!

go install github.com/yanosea/jrp/v2/app/presentation/api/jrp-server@latest

🚀 With source code

Pull the latest changes into your local repository.

🧹 Uninstallation

🔧 Uninstall jrp-server

🐭 Using go
rm $GOPATH/bin/jrp
# maybe you have to execute with sudo
rm -fr $GOPATH/pkg/mod/github.com/yanosea/jrp*
🚀 With source code

Remove the directory you cloned.

🗑️ Remove WordNet Japan sqlite database file

If you've set jrp-server envs, please replace $HOME/.local/share/jrp with envs you've set.
These below commands are in the case of default. Ofcourse you can remove whole the directory.

rm $HOME/.local/share/jrp/wnjpn.db

📃 License

🔓MIT

🖊️ Author

🏹 yanosea

🔥 Motivation

I love the smart phone application PhrasePlus!
I wanted to run an application with equivalent functionality to this in the terminal, so I created it!

🤝 Contributing

Feel free to point me in the right direction🙏