jc
version 1.25.4
查看面向開發人員的
jcPython 套件文檔
嘗試
jcWeb 演示和 REST API
jc在community.general集合中作為 Ansible 過濾器插件提供。請參閱此部落格文章的範例。
JSON 轉換
jc對許多 CLI 工具、檔案類型和常見字串的輸出進行 JSON 化，以便在腳本中更輕鬆地進行解析。有關支援的命令、檔案類型和字串，請參閱解析器部分。
dig example.com | jc --dig[{ "id" : 38052 , "opcode" : " QUERY " , "status" : " NOERROR " , "flags" :[ " qr " , " rd " , " ra " ],
"query_num" : 1 , "answer_num" : 1 , "authority_num" : 0 , "additional_num" : 1 ,
"opt_pseudosection" :{ "edns" :{ "version" : 0 , "flags" :[], "udp" : 4096 }}, "question" :
{ "name" : " example.com. " , "class" : " IN " , "type" : " A " }, "answer" :[{ "name" :
" example.com. " , "class" : " IN " , "type" : " A " , "ttl" : 39049 , "data" : " 93.184.216.34 " }],
"query_time" : 49 , "server" : " 2600:1700:bab0:d40::1#53(2600:1700:bab0:d40::1) " ,
"when" : " Fri Apr 16 16:09:00 PDT 2021 " , "rcvd" : 56 , "when_epoch" : 1618614540 ,
"when_epoch_utc" : null }]這允許透過管道命令使用jq或jello等工具對輸出進行進一步的命令列處理：
$ dig example.com | jc --dig | jq -r ' .[].answer[].data '
93.184.216.34或使用替代的“魔法”語法：
$ jc dig example.com | jq -r ' .[].answer[].data '
93.184.216.34 jc也可以用作 python 函式庫。在這種情況下，傳回的值將是一個 python 字典、一個字典列表，甚至是字典的惰性迭代而不是 JSON：
> >> import subprocess
> >> import jc
> >>
>> > cmd_output = subprocess . check_output ([ 'dig' , 'example.com' ], text = True )
> >> data = jc . parse ( 'dig' , cmd_output )
> >>
>> > data [ 0 ][ 'answer' ]
[{ 'name' : 'example.com.' , 'class' : 'IN' , 'type' : 'A' , 'ttl' : 29658 , 'data' :
'93.184.216.34' }]對於
jcPython 套件文檔，請使用help('jc')、help('jc.lib')或查看線上文檔。
數據有兩種表示形式。預設表示形式對每個解析器使用嚴格的架構，並將已知數字轉換為 int/float JSON 值。 None的某些已知值會轉換為 JSON null ，轉換已知的布林值，並且在某些情況下，會添加其他語義上下文欄位。
若要存取原始的、預先處理的 JSON，請在使用jc作為 python 函式庫時使用-r cli 選項或parse()中的raw=True函數參數。
每個解析器的模式可以在下面每個解析器旁邊的文檔連結中找到。
發行說明可以在 Github 的發行版部分找到。
有關此項目動機的更多信息，請參閱我的部落格文章「將 Unix 哲學帶入 21 世紀」以及我對 Console 的採訪。
參見：
使用案例：
有多種方法可以獲得jc 。您可以透過pip 、作業系統套件儲存庫進行安裝，或下載適合您的架構的正確二進位檔案並在檔案系統上的任何位置運行它。
pip3 install jc| 作業系統 | 命令 |
|---|---|
| Debian/Ubuntu Linux | apt-get install jc |
| 費多拉Linux | dnf install jc |
| 開放SUSE Linux | zypper install jc |
| 拱門Linux | pacman -S jc |
| 尼克斯作業系統 | nix-env -iA nixpkgs.jc或nix-env -iA nixos.jc |
| linux 系統 | guix install jc |
| Gentoo Linux | emerge dev-python/jc |
| 光子Linux | tdnf install jc |
| macOS | brew install jc |
| 自由BSD | portsnap fetch update && cd /usr/ports/textproc/py-jc && make install clean |
| Ansible 過濾器插件 | ansible-galaxy collection install community.general |
| FortiSOAR 連接器 | 從 FortiSOAR 連接器市場安裝 |
有關更多作業系統軟體包，請參閱 https://repology.org/project/jc/versions。
對於預編譯的二進位文件，請參閱 Github 上的版本。
jc接受來自STDIN的管道輸入，並將上一個指令的輸出的 JSON 表示形式輸出到STDOUT 。
COMMAND | jc [SLICE] [OPTIONS] PARSER
cat FILE | jc [SLICE] [OPTIONS] PARSER
echo STRING | jc [SLICE] [OPTIONS] PARSER或者，可以透過在要轉換的命令前面或 Proc 檔案的絕對路徑前面新增jc來使用「魔術」語法。選項可以在給予指令或 Proc 檔案路徑之前立即傳遞給jc 。 （注意：不支援指令別名和 shell 內建指令）
jc [SLICE] [OPTIONS] COMMAND
jc [SLICE] [OPTIONS] /proc/ < path-to-procfile > JSON 輸出可以是緊湊的（預設），也可以使用-p選項進行漂亮的格式化。
| 爭論 | 命令或文件類型 | 文件 |
|---|---|---|
--acpi | acpi命令解析器 | 細節 |
--airport | airport -I命令解析器 | 細節 |
--airport-s | airport -s命令解析器 | 細節 |
--apt-cache-show | apt-cache show指令解析器 | 細節 |
--apt-get-sqq | apt-get -sqq指令解析器 | 細節 |
--arp | arp命令解析器 | 細節 |
--asciitable | ASCII 和 Unicode 表解析器 | 細節 |
--asciitable-m | 多行 ASCII 和 Unicode 表解析器 | 細節 |
--blkid | blkid指令解析器 | 細節 |
--bluetoothctl | bluetoothctl命令解析器 | 細節 |
--cbt | cbt (Google Bigtable) 指令解析器 | 細節 |
--cef | CEF 字串解析器 | 細節 |
--cef-s | CEF 字串流解析器 | 細節 |
--certbot | certbot指令解析器 | 細節 |
--chage | chage --list指令解析器 | 細節 |
--cksum | cksum和sum命令解析器 | 細節 |
--clf | 通用和組合日誌格式文件解析器 | 細節 |
--clf-s | 通用和組合日誌格式檔案流解析器 | 細節 |
--crontab | crontab指令與檔案解析器 | 細節 |
--crontab-u | 具有使用者支援的crontab檔案解析器 | 細節 |
--csv | CSV 檔案解析器 | 細節 |
--csv-s | CSV 檔案流解析器 | 細節 |
--curl-head | curl --head指令解析器 | 細節 |
--date | date命令解析器 | 細節 |
--datetime-iso | ISO 8601 日期時間字串解析器 | 細節 |
--debconf-show | debconf-show指令解析器 | 細節 |
--df | df命令解析器 | 細節 |
--dig | dig命令解析器 | 細節 |
--dir | dir命令解析器 | 細節 |
--dmidecode | dmidecode命令解析器 | 細節 |
--dpkg-l | dpkg -l命令解析器 | 細節 |
--du | du指令解析器 | 細節 |
--efibootmgr | efibootmgr命令解析器 | 細節 |
--email-address | 電子郵件地址字串解析器 | 細節 |
--env | env命令解析器 | 細節 |
--ethtool | ethtool命令解析器 | 細節 |
--file | file命令解析器 | 細節 |
--find | find命令解析器 | 細節 |
--findmnt | findmnt命令解析器 | 細節 |
--finger | finger命令解析器 | 細節 |
--free | free命令解析器 | 細節 |
--fstab | /etc/fstab檔案解析器 | 細節 |
--git-log | git log指令解析器 | 細節 |
--git-log-s | git log命令流解析器 | 細節 |
--git-ls-remote | git ls-remote指令解析器 | 細節 |
--gpg | gpg --with-colons指令解析器 | 細節 |
--group | /etc/group檔案解析器 | 細節 |
--gshadow | /etc/gshadow檔案解析器 | 細節 |
--hash | hash命令解析器 | 細節 |
--hashsum | hashsum 指令解析器（ md5sum 、 shasum等） | 細節 |
--hciconfig | hciconfig命令解析器 | 細節 |
--history | history命令解析器 | 細節 |
--host | host命令解析器 | 細節 |
--hosts | /etc/hosts檔案解析器 | 細節 |
--http-headers | HTTP 標頭解析器 | 細節 |
--id | id命令解析器 | 細節 |
--ifconfig | ifconfig命令解析器 | 細節 |
--ini | INI 檔案解析器 | 細節 |
--ini-dup | 具有重複密鑰檔案解析器的 INI | 細節 |
--iostat | iostat命令解析器 | 細節 |
--iostat-s | iostat命令流解析器 | 細節 |
--ip-address | IPv4 和 IPv6 位址字串解析器 | 細節 |
--ipconfig | ipconfig Windows 命令解析器 | 細節 |
--iptables | iptables命令解析器 | 細節 |
--ip-route | ip route指令解析器 | 細節 |
--iw-scan | iw dev [device] scan指令解析器 | 細節 |
--iwconfig | iwconfig指令解析器 | 細節 |
--jar-manifest | Java MANIFEST.MF 檔案解析器 | 細節 |
--jobs | jobs命令解析器 | 細節 |
--jwt | JWT 字串解析器 | 細節 |
--kv | 鍵/值檔案和字串解析器 | 細節 |
--kv-dup | 具有重複密鑰檔案和字串解析器的鍵/值 | 細節 |
--last | last和lastb命令解析器 | 細節 |
--ls | ls指令解析器 | 細節 |
--ls-s | ls命令流解析器 | 細節 |
--lsattr | lsattr指令解析器 | 細節 |
--lsb-release | lsb_release指令解析器 | 細節 |
--lsblk | lsblk指令解析器 | 細節 |
--lsmod | lsmod指令解析器 | 細節 |
--lsof | lsof命令解析器 | 細節 |
--lspci | lspci -mmv指令解析器 | 細節 |
--lsusb | lsusb指令解析器 | 細節 |
--m3u | M3U 和 M3U8 檔案解析器 | 細節 |
--mdadm | mdadm指令解析器 | 細節 |
--mount | mount命令解析器 | 細節 |
--mpstat | mpstat命令解析器 | 細節 |
--mpstat-s | mpstat命令流解析器 | 細節 |
--needrestart | needrestart -b指令解析器 | 細節 |
--netstat | netstat指令解析器 | 細節 |
--nmcli | nmcli命令解析器 | 細節 |
--nsd-control | nsd-control命令解析器 | 細節 |
--ntpq | ntpq -p命令解析器 | 細節 |
--openvpn | openvpn-status.log 檔案解析器 | 細節 |
--os-prober | os-prober命令解析器 | 細節 |
--os-release | /etc/os-release檔案解析器 | 細節 |
--pacman | pacman命令解析器 | 細節 |
--passwd | /etc/passwd檔案解析器 | 細節 |
--path | POSIX 路徑字串解析器 | 細節 |
--path-list | POSIX 路徑清單字串解析器 | 細節 |
--pci-ids | pci.ids文件解析器 | 細節 |
--pgpass | PostgreSQL 密碼檔案解析器 | 細節 |
--pidstat | pidstat -H指令解析器 | 細節 |
--pidstat-s | pidstat -H命令流解析器 | 細節 |
--ping | ping和ping6命令解析器 | 細節 |
--ping-s | ping和ping6命令流解析器 | 細節 |
--pip-list | pip list指令解析器 | 細節 |
--pip-show | pip show指令解析器 | 細節 |
--pkg-index-apk | Alpine Linux 套件索引檔案解析器 | 細節 |
--pkg-index-deb | Debian 軟體包索引檔案解析器 | 細節 |
--plist | PLIST 檔案解析器 | 細節 |
--postconf | postconf -M命令解析器 | 細節 |
--proc | /proc/檔案解析器 | 細節 |
--ps | ps命令解析器 | 細節 |
--resolve-conf | /etc/resolve.conf檔案解析器 | 細節 |
--route | route命令解析器 | 細節 |
--rpm-qi | rpm -qi命令解析器 | 細節 |
--rsync | rsync命令解析器 | 細節 |
--rsync-s | rsync命令流解析器 | 細節 |
--semver | 語意版本字串解析器 | 細節 |
--sfdisk | sfdisk命令解析器 | 細節 |
--shadow | /etc/shadow檔案解析器 | 細節 |
--srt | SRT檔案解析器 | 細節 |
--ss | ss命令解析器 | 細節 |
--ssh-conf | ssh設定檔和ssh -G命令解析器 | 細節 |
--sshd-conf | sshd設定檔和sshd -T指令解析器 | 細節 |
--stat | stat命令解析器 | 細節 |
--stat-s | stat命令流解析器 | 細節 |
--swapon | swapon指令解析器 | 細節 |
--sysctl | sysctl命令解析器 | 細節 |
--syslog | Syslog RFC 5424 字串解析器 | 細節 |
--syslog-s | Syslog RFC 5424 字串流解析器 | 細節 |
--syslog-bsd | Syslog RFC 3164 字串解析器 | 細節 |
--syslog-bsd-s | Syslog RFC 3164 字串流解析器 | 細節 |
--systemctl | systemctl命令解析器 | 細節 |
--systemctl-lj | systemctl list-jobs指令解析器 | 細節 |
--systemctl-ls | systemctl list-sockets指令解析器 | 細節 |
--systemctl-luf | systemctl list-unit-files指令解析器 | 細節 |
--systeminfo | systeminfo資訊命令解析器 | 細節 |
--time | /usr/bin/time命令解析器 | 細節 |
--timedatectl | timedatectl status指令解析器 | 細節 |
--timestamp | Unix Epoch 時間戳字串解析器 | 細節 |
--toml | TOML 文件解析器 | 細節 |
--top | top -b命令解析器 | 細節 |
--top-s | top -b命令流解析器 | 細節 |
--tracepath | tracepath和tracepath6命令解析器 | 細節 |
--traceroute | traceroute和traceroute6指令解析器 | 細節 |
--tune2fs | tune2fs -l命令解析器 | 細節 |
--udevadm | udevadm info指令解析器 | 細節 |
--ufw | ufw status指令解析器 | 細節 |
--ufw-appinfo | ufw app info [application]指令解析器 | 細節 |
--uname | uname -a指令解析器 | 細節 |
--update-alt-gs | update-alternatives --get-selections命令解析器 | 細節 |
--update-alt-q | update-alternatives --query指令解析器 | 細節 |
--upower | upower命令解析器 | 細節 |
--uptime | uptime命令解析器 | 細節 |
--url | URL 字串解析器 | 細節 |
--ver | 版本字串解析器 | 細節 |
--veracrypt | veracrypt命令解析器 | 細節 |
--vmstat | vmstat指令解析器 | 細節 |
--vmstat-s | vmstat命令流解析器 | 細節 |
--w | w命令解析器 | 細節 |
--wc | wc命令解析器 | 細節 |
--wg-show | wg show命令解析器 | 細節 |
--who | who命令解析器 | 細節 |
--x509-cert | X.509 PEM 和 DER 憑證檔案解析器 | 細節 |
--x509-csr | X.509 PEM 和 DER 憑證請求檔案解析器 | 細節 |
--xml | XML 檔案解析器 | 細節 |
--xrandr | xrandr指令解析器 | 細節 |
--yaml | YAML 檔案解析器 | 細節 |
--zipinfo | zipinfo指令解析器 | 細節 |
--zpool-iostat | zpool iostat指令解析器 | 細節 |
--zpool-status | zpool status命令解析器 | 細節 |
| 短的 | 長的 | 描述 |
|---|---|---|
-a | --about | 關於jc .列印有關jc和解析器的資訊（當然是 JSON 或 YAML！） |
-C | --force-color | 即使使用管道也強制輸出顏色（覆蓋-m和NO_COLOR環境變數） |
-d | --debug | 調試模式。如果遇到解析問題，則列印追蹤訊息（使用-dd進行詳細偵錯） |
-h | --help | 幫助。使用jc -h --parser_name取得解析器文件。使用兩次顯示隱藏的解析器（例如-hh ）。使用三次來顯示解析器類別（例如-hhh ）。 |
-m | --monochrome | 單色輸出 |
-M | --meta-out | 將元資料加入輸出，包括時間戳記、解析器名稱、魔術指令、魔術指令退出程式碼等。 |
-p | --pretty | 漂亮格式化 JSON 輸出 |
-q | --quiet | 安靜模式。抑制解析器警告訊息（使用-qq忽略流解析器錯誤） |
-r | --raw | 原始輸出。提供更多的文字輸出，通常帶有字串值並且沒有額外的語義處理 |
-s | --slurp | 將多行放入一個陣列中。 （使用-hhh查找相容的解析器） |
-u | --unbuffer | 取消緩衝輸出 |
-v | --version | 版本資訊 |
-y | --yaml-out | YAML 輸出 |
-B | --bash-comp | 產生 Bash shell 完成腳本（更多資訊） |
-Z | --zsh-comp | 產生 Zsh shell 完成腳本（更多資訊） |
使用類似 Python 切片的START:STOP語法支援行切片。這允許您跳過您想要jc轉換的STDIN輸入的開頭和/或結尾處的行。
START和STOP可以是正整數、負整數或空白，並允許您指定要跳過的行數和要處理的行數。正片和空白片的記憶效率最高。切片中的任何負整數都會使用更多記憶體。
例如，要跳過以下文字的第一行和最後一行，您可以透過多種方式表達切片：
$ cat table.txt
# ## We want to skip this header ###
col1 col2
foo 1
bar 2
# ## We want to skip this footer ###
$ cat table.txt | jc 1:-1 --asciitable
[{ " col1 " : " foo " , " col2 " : " 1 " },{ " col1 " : " bar " , " col2 " : " 2 " }]
$ cat table.txt | jc 1:4 --asciitable
[{ " col1 " : " foo " , " col2 " : " 1 " },{ " col1 " : " bar " , " col2 " : " 2 " }]在此範例中， 1:-1和1:4線切片提供相同的輸出。
當使用正整數時， STOP的索引位置不包含在內。正切片從輸入的第一行開始計數，從0作為第一行開始計數。負切片從最後一行開始向開頭計數，從-1開始作為最後一行。這也是Python 切片功能的工作方式。
以下是線切片選項的細分：
| 切片表示法 | 已處理的輸入行 |
|---|---|
START:STOP | 線START到STOP - 1 |
START: | 行START到輸出的其餘部分 |
:STOP | 從開頭到STOP - 1行 |
-START:STOP | START行從末尾到STOP - 1 |
START:-STOP | START行到STOP行（從末尾開始） |
-START:-STOP | 從末端開始的START線到從末端開始的STOP線 |
-START: | START行從末尾到輸出的其餘部分 |
:-STOP | 從開頭到結尾的STOP行 |
: | 所有線路 |
一些解析器支援多項輸入，並且可以在一次傳遞中輸出結果數組。 Slurping 適用於接受單行輸入的字串解析器。 （例如url和ip-address ）要查看支援--slurp選項的解析器列表，請使用jc -hhh 。
例如，您可以使用--slurp選項將具有多個 IP 位址（每行一個）的檔案傳送至jc ，並且將輸出一組結果：
$ cat ip-addresses.txt | jc --slurp --ip-address
[ < multiple output objects > ] /proc檔案的神奇語法會自動支援多個檔案的 slurping（無需使用--slurp選項）。例如，您可以一次轉換多個 PID 檔案：
$ jc /proc/ * /status
[ < multiple output objects > ]當使用/proc magic 語法並選擇多個檔案時，會在輸出中插入一個附加的_file字段，以便更容易判斷每個輸出物件所引用的檔案。
最後， --meta-out選項可以與 slurped 輸出結合使用。在這種情況下，slurped 輸出被包裝在具有以下結構的物件中：
{
"result" : [ <multiple output objects> ],
"_jc_meta" : {
"parser" : " url " ,
"timestamp" : 1706235558.654576 ,
"slice_start" : null ,
"slice_end" : null ,
"input_list" : [
" http://www.google.com " ,
" https://www.apple.com " ,
" https://www.microsoft.com "
]
}
}使用--meta-out ， input_list包含輸入清單（實際輸入字串或/proc檔案名稱），以便您可以識別與每個輸入字串或/proc檔案名稱相關的輸出物件。
jc內的任何致命錯誤都會產生退出代碼100 ，否則退出代碼將為0 。
當使用「魔術」語法（例如jc ifconfig eth0 ）時， jc將儲存正在解析的程式的退出程式碼並將其新增至jc退出程式碼。這樣可以更容易確定錯誤是否來自解析的程式或jc 。
考慮使用ifconfig的以下範例：
ifconfig退出程式碼 | jc退出代碼 | 組合退出代碼 | 解釋 |
|---|---|---|---|
0 | 0 | 0 | 沒有錯誤 |
1 | 0 | 1 | ifconfig錯誤 |
0 | 100 | 100 | jc中的錯誤 |
1 | 100 | 101 | ifconfig和jc皆出錯 |
當使用「magic」語法時，您也可以使用--meta-out或-M選項來檢索被呼叫程式的退出代碼。這會將_jc_meta物件附加到輸出，其中將包含魔術命令訊息，包括退出代碼。
這是ping的範例：
$ jc --meta-out -p ping -c2 192.168.1.252
{
" destination_ip " : " 192.168.1.252 " ,
" data_bytes " : 56,
" pattern " : null,
" destination " : " 192.168.1.252 " ,
" packets_transmitted " : 2,
" packets_received " : 0,
" packet_loss_percent " : 100.0,
" duplicates " : 0,
" responses " : [
{
" type " : " timeout " ,
" icmp_seq " : 0,
" duplicate " : false
}
],
" _jc_meta " : {
" parser " : " ping " ,
" timestamp " : 1661357115.27949,
" magic_command " : [
" ping " ,
" -c2 " ,
" 192.168.1.252 "
],
" magic_command_exit " : 2
}
}
$ echo $?
2您可以透過JC_COLORS環境變數指定自訂顏色。 JC_COLORS環境變數採用四個逗號分隔的字串值，格式如下：
JC_COLORS= < keyname_color > , < keyword_color > , < number_color > , < string_color >其中顏色為： black 、 red 、 green 、 yellow 、 blue 、 magenta 、 cyan 、 gray 、 brightblack 、 brightred 、 brightgreen 、 brightyellow 、 brightblue 、 brightmagenta 、 brightcyan 、 white或default
例如，設定為預設顏色：
JC_COLORS=blue,brightblack,magenta,green或者
JC_COLORS=default,default,default,default您可以將NO_COLOR環境變數設定為任何值以停用jc中的顏色輸出。請注意，使用-C選項強制顏色輸出將覆蓋NO_COLOR環境變數和-m選項。
大多數解析器從STDIN載入所有數據，解析它，然後串列輸出整個 JSON 文件。有一些流解析器（例如ls-s和ping-s ）在從STDIN接收資料時立即開始處理資料並將其作為 JSON 行（又稱 NDJSON）逐行輸出。這可以顯著減少解析大量命令輸出（例如ls -lR / ）所需的記憶體量，有時可以更快地處理資料。流式解析器的行為與標準解析器略有不同，如下所述。
注意：流解析器不能與“magic”語法一起使用
使用流程解析器時，您可能想要忽略解析錯誤，因為這些解析器可能用於長期存在的處理管道，錯誤可能會破壞管道。若要忽略解析錯誤，請在parse()函數中使用-qq cli 選項或ignore_exceptions=True參數。這會將_jc_meta物件加入到帶有success屬性的 JSON 輸出。如果success為true ，那麼解析該行就沒有問題。如果success為false ，則發現解析問題，並且將添加error和line字段以分別包含簡短的錯誤描述和不可解析行的內容：
使用-qq選項成功解析行：
{
"command_data" : " data " ,
"_jc_meta" : {
"success" : true
}
}使用-qq選項解析行失敗：
{
"_jc_meta" : {
"success" : false ,
"error" : " error message " ,
"line" : " original line data "
}
}大多數作業系統都會緩衝從一個行程傳送到另一個行程的輸出。緩衝區通常在 4KB 左右。在終端機中查看輸出時，作業系統緩衝區未佔用，因此輸出會立即顯示在螢幕上。但是，當將多個進程連接在一起時，當輸入資料非常慢時（例如ping ），輸出可能看起來像是掛起：
$ ping 1.1.1.1 | jc --ping-s | jq
<slow output>
這是因為在此範例中作業系統佔用了jc和jq之間的 4KB 緩衝區。若要在終端機上即時顯示數據，您可以使用-u (unbuffer) cli 選項停用緩衝區：
$ ping 1.1.1.1 | jc --ping-s -u | jq
{"type":"reply","pattern":null,"timestamp":null,"bytes":"64","respons...}
{"type":"reply","pattern":null,"timestamp":null,"bytes":"64","respons...}
...
注意：對於大數據流，無緩衝輸出可能會較慢。
流解析器接受任何可迭代物件並傳回允許延遲處理資料的可迭代物件。輸入資料應在字串資料行上迭代。好的輸入資料的範例是sys.stdin或str.splitlines() 。
要在程式碼中使用返回的可迭代對象，只需循環它或使用 next() 內建函數：
import jc
result = jc . parse ( 'ls_s' , ls_command_output . splitlines ())
for item in result :
print ( item [ "filename" ])解析器插件可以放置在本機「應用程式資料目錄」的jc/jcparsers資料夾中：
$HOME/.local/share/jc/jcparsers$HOME/Library/Application Support/jc/jcparsers$LOCALAPPDATAjcjcjcparsers解析器插件是標準的 python 模組檔案。使用jc/parsers/foo.py或jc/parsers/foo_s.py (streaming)解析器作為模板，只需將.py檔案放在jcparsers子資料夾中即可。任何依賴項都可以放置在jcparsers上方的jc資料夾中，並且可以在解析器程式碼中導入。
解析器插件檔案名稱必須是有效的 python 模組名稱，因此必須以字母開頭並完全由字母數字和底線組成。本機插件可能會覆蓋預設解析器。
注意：應用程式資料目錄遵循XDG基本目錄規範
為了獲得最佳結果，請透過修改LC_ALL變數將區域設定環境變數設定為C或en_US.UTF-8 ：
$ LC_ALL=C date | jc --date
您也可以單獨設定區域設定變數：
$ export LANG=C
$ export LC_NUMERIC=C
在某些較舊的系統上，如果C語言環境不支援 UTF-8 編碼，則 UTF-8 輸出將降級為帶有\u轉義序列的 ASCII。
一些解析器已將計算的紀元時間戳字段添加到輸出中。除非時間戳字段名稱具有_utc後綴，否則它被認為是幼稚的。 （即基於運行jc解析器的系統的本機時區）。
如果可以在指令輸出的文字中偵測到 UTC 時區，則時間戳記將是時區感知的，並且金鑰名稱上有_utc後綴。 （例如epoch_utc ）感知時間戳記不支持其他時區。
jc可以在大多數 shell 中使用。一些現代 shell 內建了 JSON 反序列化和過濾功能，這使得使用jc更加方便。
例如，NGS（下一代 Shell）中可以進行以下操作：
myvar = ` ` jc dig www.google.com ` ` [0].answer[0].data這會執行jc ，解析輸出 JSON，並將結果資料結構指派給單行程式碼中的變數。
有關如何在其他 shell 中使用jc的更多範例，請參閱此 wiki 頁面。
一些解析器（例如dig 、 xml 、 csv等）可以在任何平台上運作。其他轉換特定於平台的輸出的解析器如果在不受支援的平台上運行，將產生警告訊息。若要查看所有解析器資訊（包括相容性），請執行jc -ap 。
您可能仍然在不支援的平台上使用解析器 - 例如，您可能想要在 macOS 或 Windows 筆記型電腦上解析具有 linux lsof輸出的檔案。在這種情況下，您可以使用-q cli 選項或parse()中的quiet=True函數參數來抑制警告訊息：
蘋果系統：
cat lsof.out | jc -q --lsof或Windows：
type lsof.out | jc -q --lsof測試於：
請隨意添加/改進程式碼或解析器！您可以使用jc/parsers/foo.py或jc/parsers/foo_s.py (streaming)解析器作為模板，並透過拉取請求提交解析器。
請參閱貢獻指南以獲取更多資訊。
ifconfig-parser模組由 KnightWhoSayNi 提供xmltodict模組ruamel.yaml模組，作者：Anthon van der Neuttrparse模組以下是jc輸出的一些範例。如需更多範例，請參閱此處或解析器文件。
arp | jc -p --arp # or: jc -p arp [
{
