Sign inSign up

nnsnodnb/shodo

By nnsnodnb

•Updated 4 days ago

Image
0

1.1K

nnsnodnb/shodo repository overview

⁠shodo

Docker image that includes the shodo⁠ package provided by ZenProducts Inc.

⁠Installation

$ docker pull nnsnodnb/shodo:latest

⁠Usage

Shodo⁠ account is required to use the shodo command.

⁠Authorization
  1. How to pass SHODO_API_ROOT and SHODO_API_TOKEN as environment variables.
  2. Mount the local ~/.config/shodo/credentials to /shodo/credentials in the container.
$ docker run -it \
  -v ~/.config/shodo/credentials:/shodo/credentials \
  nnsnodnb/shodo:latest lint
⁠Lint Japanese
  1. Input japanese

To finish input and request proofreading, press Ctrl + Z on Windows or Ctrl + D on Mac and Linux.

$ docker run -it \
  -e SHODO_API_ROOT=my-shodo-api-root \
  -e SHODO_API_TOKEN=my-shodo-api-token \
  nnsnodnb/shodo:latest lint
飛行機の欠便があり、運行状況が変わった。 # Your input text
Linting...
39:11 もしかして:変換ミス
     飛行機の欠便があり、運行(→ 運航)状況が変わった。
  1. Input file

Mount the text file under the /shodo directory and specify the file after the lint command.

$ docker run -t \
  -e SHODO_API_ROOT=my-shodo-api-root \
  -e SHODO_API_TOKEN=my-shodo-api-token \
  -v $(pwd)/README.md:/shodo/README.md \
  nnsnodnb/shodo:latest lint /shodo/README.md
Linting...
39:11 もしかして:変換ミス
     飛行機の欠便があり、運行(→ 運航)状況が変わった。
⁠Download files

Specify the directory where you want to save the downloaded files.
Unless otherwise specified, files will be downloaded to /shodo/docs in the container.

$ docker run \
  -e SHODO_API_ROOT=my-shodo-api-root \
  -e SHODO_API_TOKEN=my-shodo-api-token \
  -v $(pwd):/shodo/docs \
  nnsnodnb/shodo:latest download

⁠License

This software is licensed under the MIT License. (See LICENSE⁠)

Tag summary

Content type

Image

Digest

sha256:1633e9f22…

Size

22.9 MB

Last updated

4 days ago

docker pull nnsnodnb/shodo