From 1d19595996ab523547c369dced81aa8d3acd432e Mon Sep 17 00:00:00 2001 From: Pradeep Chhetri Date: Sun, 6 Oct 2019 23:20:48 +0800 Subject: [PATCH] Add documentation for the sys command --- docs/commands/sys.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/commands/sys.md diff --git a/docs/commands/sys.md b/docs/commands/sys.md new file mode 100644 index 0000000000..b21a0ef219 --- /dev/null +++ b/docs/commands/sys.md @@ -0,0 +1,32 @@ +# sys + +This command gives information about the system where nu is running on. + +## Examples + +```shell +> sys +━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━ + host │ cpu │ disks │ mem │ net │ battery +────────────────┼────────────────┼─────────────────┼────────────────┼──────────────────┼──────────────── + [table: 1 row] │ [table: 1 row] │ [table: 3 rows] │ [table: 1 row] │ [table: 18 rows] │ [table: 1 row] +━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━ +> sys | get host +━━━━━━━━┯━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━ + name │ release │ hostname │ arch │ uptime │ users +────────┼─────────┼──────────────┼────────┼────────────────┼────────────────── + Darwin │ 18.7.0 │ C02Y437GJGH6 │ x86_64 │ [table: 1 row] │ [table: 17 rows] +━━━━━━━━┷━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━ +> sys | get cpu +━━━━━━━┯━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━ + cores │ current ghz │ min ghz │ max ghz +───────┼───────────────────┼───────────────────┼─────────────────── + 12 │ 2.600000000000000 │ 2.600000000000000 │ 2.600000000000000 +━━━━━━━┷━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━ +> sys | get mem +━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━ + total │ free │ swap total │ swap free +─────────┼──────────┼────────────┼─────────── + 34.4 GB │ 545.0 MB │ 2.1 GB │ 723.0 MB +━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━ +``` \ No newline at end of file