https://github.com/goark/gnkf
Network Kanji Filter by Golang
https://github.com/goark/gnkf
character-encoding command-line-tool encoding golang-application hash network-kanji-filter unicode
Last synced: about 1 month ago
JSON representation
Network Kanji Filter by Golang
- Host: GitHub
- URL: https://github.com/goark/gnkf
- Owner: goark
- License: apache-2.0
- Created: 2020-07-27T04:22:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-15T23:00:18.000Z (10 months ago)
- Last Synced: 2025-10-13T09:57:20.747Z (4 months ago)
- Topics: character-encoding, command-line-tool, encoding, golang-application, hash, network-kanji-filter, unicode
- Language: Go
- Homepage:
- Size: 960 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [gnkf] -- Network Kanji Filter by Golang
[](https://github.com/goark/gnkf/actions)
[](https://github.com/goark/gnkf/actions)
[](https://raw.githubusercontent.com/goark/gnkf/master/LICENSE)
[](https://github.com/goark/gnkf/releases/latest)
This package is required Go 1.16 or later.
**Migrated repository to [github.com/goark/gnkf][gnkf]**
## Build and Install
```
$ go install github.com/goark/gnkf@latest
```
### Binaries
See [latest release](https://github.com/goark/gnkf/releases/latest).
## Usage
```
$ gnkf -h
Network Kanji Filter by Golang
Usage:
gnkf [flags]
gnkf [command]
Available Commands:
base64 Encode/Decode BASE64
bcrypt Hash and compare by BCrypt
completion Generate completion script
dump Hexadecimal view of octet data stream
enc Convert character encoding of the text
guess Guess character encoding of the text
hash Print or check hash value
help Help about any command
kana Convert kana characters in the text
newline Convert newline form in the text
norm Unicode normalization of the text
remove-bom Remove BOM character in UTF-8 string
version Print the version number
width Convert character width in the text
Flags:
--debug for debug
-h, --help help for gnkf
Use "gnkf [command] --help" for more information about a command.
```
### gnkf guess command
```
$ gnkf guess -h
Guess character encoding of the text
Usage:
gnkf guess [flags]
Aliases:
guess, g
Flags:
--all print all guesses
-f, --file string path of input text file
-h, --help help for guess
Global Flags:
--debug for debug
$ echo こんにちは，世界 | gnkf guess --all
UTF-8
windows-1255
windows-1253
Big5
GB-18030
Shift_JIS
```
### gnkf enc command
```
$ gnkf enc -h
Convert character encoding of the text.
Using MIME and IANA name as the character encoding name.
Refer: http://www.iana.org/assignments/character-sets/character-sets.xhtml
Usage:
gnkf enc [flags]
Aliases:
enc, encoding, e
Flags:
-d, --dst-encoding string character encoding name of output text (default "utf-8")
-f, --file string path of input text file
-g, --guess guess character encoding of source text
-h, --help help for enc
-o, --output string path of output file
-b, --remove-bom remove BOM character in source text (UTF-8 only)
-s, --src-encoding string character encoding name of source text (default "utf-8")
Global Flags:
--debug for debug
$ echo こんにちは，世界 | gnkf enc -g -d shift_jis | gnkf dump
0x82, 0xb1, 0x82, 0xf1, 0x82, 0xc9, 0x82, 0xbf, 0x82, 0xcd, 0x81, 0x43, 0x90, 0xa2, 0x8a, 0x45, 0x0a
```
### gnkf newline command
```
$ gnkf newline -h
Convert newline form in the text.
Usage:
gnkf newline [flags]
Aliases:
newline, nwln, nl
Flags:
-f, --file string path of input text file
-h, --help help for newline
-n, --newline-form string newline form: [lf|cr|crlf] (default "lf")
-o, --output string path of output file
Global Flags:
--debug for debug
$ echo こんにちは，世界 | gnkf newline -n crlf | gnkf dump --unicode
0x3053, 0x3093, 0x306b, 0x3061, 0x306f, 0xff0c, 0x4e16, 0x754c, 0x000d, 0x000a
```
### gnkf norm command
```
$ gnkf norm -h
Unicode normalization of the text (UTF-8 encoding only).
Usage:
gnkf norm [flags]
Aliases:
norm, normalize, nrm, nm
Flags:
-f, --file string path of input text file
-h, --help help for norm
-k, --kangxi-radicals normalize kangxi radicals only (with nfkc or nfkd form)
-n, --norm-form string Unicode normalization form: [nfc|nfd|nfkc|nfkd] (default "nfc")
-o, --output string path of output file
-b, --remove-bom remove BOM character
Global Flags:
--debug for debug
$ echo ﾍﾟﾝｷﾞﾝ | gnkf norm -n nfkc | gnkf dump --unicode
0x30da, 0x30f3, 0x30ae, 0x30f3, 0x000a
```
#### Normalize Kangxi Radicals
```
$ echo ㈱埼⽟ | gnkf dump --unicode
0x3231, 0x57fc, 0x2f5f, 0x000a
$ echo ㈱埼⽟ | gnkf norm -n nfkc -k | gnkf dump --unicode
0x3231, 0x57fc, 0x7389, 0x000a
```
### gnkf width command
```
$ gnkf width -h
Convert character width in the text (UTF-8 encoding only).
Usage:
gnkf width [flags]
Aliases:
width, wdth, w
Flags:
-c, --conversion-form string conversion form: [fold|narrow|widen] (default "fold")
-f, --file string path of input text file
-h, --help help for width
-o, --output string path of output file
-b, --remove-bom remove BOM character
Global Flags:
--debug for debug
$ echo ペンギン | gnkf width -c narrow | gnkf dump --unicode
0xff8d, 0xff9f, 0xff9d, 0xff77, 0xff9e, 0xff9d, 0x000a
```
### gnkf kana command
```
$ gnkf kana -h
Convert kana characters in the text.
UTF-8 encoding only.
"hiragana" and "katakana" forms are valid only for full-width kana character.
Usage:
gnkf kana [flags]
Aliases:
kana, k
Flags:
-c, --conversion-form string conversion form: [hiragana|katakana|chokuon] (default "katakana")
-f, --file string path of input text file
--fold convert character width by fold form
-h, --help help for kana
-o, --output string path of output file
-b, --remove-bom remove BOM character
Global Flags:
--debug for debug
$ echo こんにちは | gnkf kana -c katakana
コンニチハ
```
#### Convert 直音 (Chokuon; Upper kana characters)
```
$ echo ニッポン | gnkf kana -c chokuon
ニツポン
```
### gnkf base64 command
```
$ gnkf base64 -h
Encode/Decode BASE64.
Usage:
gnkf base64 [flags]
Aliases:
base64, b64
Flags:
-d, --decode decode BASE64 string
-f, --file string path of input text file
-u, --for-url encoding/decoding defined in RFC 4648
-h, --help help for base64
-p, --no-padding no padding
-o, --output string path of output file
Global Flags:
--debug for debug
$ echo Hello World | gnkf b64
SGVsbG8gV29ybGQK
$ echo SGVsbG8gV29ybGQK | gnkf b64 -d
Hello World
```
### gnkf bcrypt command
```
$ gnkf bcrypt -h
Hash and compare by BCrypt.
Usage:
gnkf bcrypt [flags] string [string...]
Aliases:
bcrypt, bc
Flags:
--compare string compare to BCrypt hashed string
-c, --cost int BCrypt cost (4-31) (default 10)
-h, --help help for bcrypt
Global Flags:
--debug for debug
$ gnkf bc password
$2a$10$vvbBuQoVR9AFis6J4xtZ0espSfe976pZ1Em669nhdg2loAm2Yjxl2
$ gnkf bc --compare '$2a$10$vvbBuQoVR9AFis6J4xtZ0espSfe976pZ1Em669nhdg2loAm2Yjxl2' password
compare BCrypt hashed string '$2a$10$vvbBuQoVR9AFis6J4xtZ0espSfe976pZ1Em669nhdg2loAm2Yjxl2' to...
password : match!
```
### gnkf hash command
```
$ gnkf hash -h
Print or check hash value.
Support algorithm:
MD5, SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256
Usage:
gnkf hash [flags] [file]
Aliases:
hash, h
Flags:
-a, --algorithm string hash algorithm (default "SHA-256")
-c, --check don't fail or report status for missing files
-h, --help help for hash
--ignore-missing don't fail or report status for missing files (with check option)
--quiet don't print OK for each successfully verified file (with check option)
Global Flags:
--debug for debug
$ echo Hello World | gnkf h
d2a84f4b8b650937ec8f73cd8be2c74add5a911ba64df27458ed8229da804a26 -
$ gnkf h hash/testdata/null.dat
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 hash/testdata/null.dat
$ gnkf h hash/testdata/null.dat | gnkf h -c
hash/testdata/null.dat: OK
```
### gnkf remove-bom command
```
$ gnkf remove-bom -h
Remove BOM character in UTF-8 string.
Usage:
gnkf remove-bom [flags]
Aliases:
remove-bom, rbom, rb
Flags:
-f, --file string path of input text file
-h, --help help for remove-bom
-o, --output string path of output file
Global Flags:
--debug for debug
$ echo Hello | gnkf dump
0xef, 0xbb, 0xbf, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x0a
$ echo Hello | gnkf remove-bom | gnkf dump
0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x0a
```
### gnkf dump command
```
$ gnkf dump -h
Hexadecimal view of octet data stream with C language array style.
Usage:
gnkf dump [flags]
Aliases:
dump, hexdump, d, hd
Flags:
-f, --file string path of input text file
-h, --help help for dump
-u, --unicode print by Unicode code point (UTF-8 only)
Global Flags:
--debug for debug
$ echo ペンギン | gnkf dump
0xe3, 0x83, 0x9a, 0xe3, 0x83, 0xb3, 0xe3, 0x82, 0xae, 0xe3, 0x83, 0xb3, 0x0a
$ echo ペンギン | gnkf dump --unicode
0x30da, 0x30f3, 0x30ae, 0x30f3, 0x000a
```
## Modules Requirement Graph
[](./dependency.png)
[gnkf]: https://github.com/goark/gnkf "goark/gnkf: Network Kanji Filter by Golang"