|
|
2 ماه پیش | |
|---|---|---|
| .github | 2 ماه پیش | |
| .idea | 2 ماه پیش | |
| RackPeek | 2 ماه پیش | |
| RackPeek.Domain | 2 ماه پیش | |
| Tests | 2 ماه پیش | |
| .DS_Store | 2 ماه پیش | |
| .gitignore | 2 ماه پیش | |
| COMMANDS.md | 2 ماه پیش | |
| LICENSE | 2 ماه پیش | |
| README.md | 2 ماه پیش | |
| RackPeek.sln | 2 ماه پیش | |
| generate_commands_markdown.sh | 2 ماه پیش | |
| servers.yaml | 2 ماه پیش |
RackPeek is a lightweight CLI tool for managing and documenting your IT infrastructure and home lab. Track servers, switches, routers, desktops, access points, UPS systems, and more — including software systems, services, and networks — all from the command line. It’s designed to help you inventory, configure, and audit your environment in a consistent, reusable way.
rpkrpk switchesrpk switches summaryrpk switches addrpk switches listrpk switches getrpk switches describerpk switches setrpk switches delrpk systemsrpk systems summaryrpk systems addrpk systems listrpk systems getrpk systems describerpk systems setrpk systems delrpk accesspointsrpk accesspoints summaryrpk accesspoints addrpk accesspoints listrpk accesspoints getrpk accesspoints describerpk accesspoints setrpk accesspoints delrpk upsrpk ups summaryrpk ups addrpk ups listrpk ups getrpk ups describerpk ups setrpk ups delrpk desktopsrpk desktops addrpk desktops listrpk desktops getrpk desktops describerpk desktops setrpk desktops delrpk desktops cpurpk desktops cpu addrpk desktops cpu setrpk desktops cpu delrpk desktops driverpk desktops drive addrpk desktops drive setrpk desktops drive delrpk desktops gpurpk desktops gpu addrpk desktops gpu setrpk desktops gpu delrpk desktops nicrpk desktops nic addrpk desktops nic setrpk desktops nic delrpk servicesrpk services summaryrpk services addrpk services listrpk services getrpk services describerpk services setrpk services delrpk aprpk serversrpk servers summaryrpk servers addrpk servers getrpk servers describerpk servers setrpk servers delrpk servers treerpk servers cpurpk servers cpu addrpk servers cpu setrpk servers cpu delrpk servers driverpk servers drive addrpk servers drive setrpk servers drive delrpk servers gpurpk servers gpu addrpk servers gpu setrpk servers gpu delrpk servers nicrpk servers nic addrpk servers nic setrpk servers nic delrpkUSAGE:
rpk [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
switches Manage switches
systems Manage systems
accesspoints Manage access points
ups Manage UPS units
services Manage services
ap Show access point hardware report
desktops Show desktop hardware report
ups Show UPS hardware report
servers Manage servers
rpk switchesDESCRIPTION:
Manage switches
USAGE:
rpk switches [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
summary Show switch hardware report
add <name> Add a new switch
list List switches
get <name> Get a switches by name
describe <name> Show detailed information about a switch
set <name> Update switch properties
del <name> Delete a switch
rpk switches summaryDESCRIPTION:
Show switch hardware report
USAGE:
rpk switches summary [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk switches addDESCRIPTION:
Add a new switch
USAGE:
rpk switches add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk switches listDESCRIPTION:
List switches
USAGE:
rpk switches list [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk switches getDESCRIPTION:
Get a switches by name
USAGE:
rpk switches get <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk switches describeDESCRIPTION:
Show detailed information about a switch
USAGE:
rpk switches describe <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk switches setDESCRIPTION:
Update switch properties
USAGE:
rpk switches set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--Model
--managed
--poe
rpk switches delDESCRIPTION:
Delete a switch
USAGE:
rpk switches del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk systemsDESCRIPTION:
Manage systems
USAGE:
rpk systems [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
summary Show system report
add <name> Add a new system
list List systems
get <name> Get a system by name
describe <name> Show detailed information about a system
set <name> Update system properties
del <name> Delete a system
rpk systems summaryDESCRIPTION:
Show system report
USAGE:
rpk systems summary [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk systems addDESCRIPTION:
Add a new system
USAGE:
rpk systems add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk systems listDESCRIPTION:
List systems
USAGE:
rpk systems list [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk systems getDESCRIPTION:
Get a system by name
USAGE:
rpk systems get <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk systems describeDESCRIPTION:
Show detailed information about a system
USAGE:
rpk systems describe <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk systems setDESCRIPTION:
Update system properties
USAGE:
rpk systems set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--type
--os
--cores
--ram
--runs-on
rpk systems delDESCRIPTION:
Delete a system
USAGE:
rpk systems del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk accesspointsDESCRIPTION:
Manage access points
USAGE:
rpk accesspoints [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
summary Show access point hardware report
add <name> Add a new access point
list List access points
get <name> Get an access point by name
describe <name> Show detailed information about an access point
set <name> Update access point properties
del <name> Delete an access point
rpk accesspoints summaryDESCRIPTION:
Show access point hardware report
USAGE:
rpk accesspoints summary [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk accesspoints addDESCRIPTION:
Add a new access point
USAGE:
rpk accesspoints add <name> [OPTIONS]
ARGUMENTS:
<name> The access point name
OPTIONS:
-h, --help Prints help information
rpk accesspoints listDESCRIPTION:
List access points
USAGE:
rpk accesspoints list [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk accesspoints getDESCRIPTION:
Get an access point by name
USAGE:
rpk accesspoints get <name> [OPTIONS]
ARGUMENTS:
<name> The access point name
OPTIONS:
-h, --help Prints help information
rpk accesspoints describeDESCRIPTION:
Show detailed information about an access point
USAGE:
rpk accesspoints describe <name> [OPTIONS]
ARGUMENTS:
<name> The access point name
OPTIONS:
-h, --help Prints help information
rpk accesspoints setDESCRIPTION:
Update access point properties
USAGE:
rpk accesspoints set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--model The access point model name
--speed The speed of the access point in Gb
rpk accesspoints delDESCRIPTION:
Delete an access point
USAGE:
rpk accesspoints del <name> [OPTIONS]
ARGUMENTS:
<name> The access point name
OPTIONS:
-h, --help Prints help information
rpk upsDESCRIPTION:
Manage UPS units
USAGE:
rpk ups [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
summary Show UPS hardware report
add <name> Add a new UPS
list List UPS units
get <name> Get a UPS by name
describe <name> Show detailed information about a UPS
set <name> Update UPS properties
del <name> Delete a UPS
rpk ups summaryDESCRIPTION:
Show UPS hardware report
USAGE:
rpk ups summary [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk ups addDESCRIPTION:
Add a new UPS
USAGE:
rpk ups add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk ups listDESCRIPTION:
List UPS units
USAGE:
rpk ups list [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk ups getDESCRIPTION:
Get a UPS by name
USAGE:
rpk ups get <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk ups describeDESCRIPTION:
Show detailed information about a UPS
USAGE:
rpk ups describe <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk ups setDESCRIPTION:
Update UPS properties
USAGE:
rpk ups set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--model
--va
rpk ups delDESCRIPTION:
Delete a UPS
USAGE:
rpk ups del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk desktopsUSAGE:
rpk desktops [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <name>
list
get <name>
describe <name>
set <name>
del <name>
cpu
drive
gpu
nic
rpk desktops addUSAGE:
rpk desktops add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk desktops listUSAGE:
rpk desktops list [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk desktops getUSAGE:
rpk desktops get <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk desktops describeUSAGE:
rpk desktops describe <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk desktops setUSAGE:
rpk desktops set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--model
rpk desktops delUSAGE:
rpk desktops del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk desktops cpuUSAGE:
rpk desktops cpu [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <desktop>
set <desktop> <index>
del <desktop> <index>
rpk desktops cpu addUSAGE:
rpk desktops cpu add <desktop> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
OPTIONS:
-h, --help Prints help information
--model The model name
--cores The number of cpu cores
--threads The number of cpu threads
rpk desktops cpu setUSAGE:
rpk desktops cpu set <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
<index> The index of the desktop cpu
OPTIONS:
-h, --help Prints help information
--model The cpu model
--cores The number of cpu cores
--threads The number of cpu threads
rpk desktops cpu delUSAGE:
rpk desktops cpu del <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The name of the desktop
<index> The index of the desktop cpu to remove
OPTIONS:
-h, --help Prints help information
rpk desktops driveUSAGE:
rpk desktops drive [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <desktop>
set <desktop> <index>
del <desktop> <index>
rpk desktops drive addUSAGE:
rpk desktops drive add <desktop> [OPTIONS]
ARGUMENTS:
<desktop> The name of the desktop
OPTIONS:
-h, --help Prints help information
--type The drive type e.g hdd / ssd
--size The drive capacity in Gb
rpk desktops drive setUSAGE:
rpk desktops drive set <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
<index> The drive index to update
OPTIONS:
-h, --help Prints help information
--type The drive type e.g hdd / ssd
--size The drive capacity in Gb
rpk desktops drive delUSAGE:
rpk desktops drive del <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The name of the desktop
<index> The index of the drive to remove
OPTIONS:
-h, --help Prints help information
rpk desktops gpuUSAGE:
rpk desktops gpu [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <desktop>
set <desktop> <index>
del <desktop> <index>
rpk desktops gpu addUSAGE:
rpk desktops gpu add <desktop> [OPTIONS]
ARGUMENTS:
<desktop> The name of the desktop
OPTIONS:
-h, --help Prints help information
--model The Gpu model
--vram The amount of gpu vram in Gb
rpk desktops gpu setUSAGE:
rpk desktops gpu set <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
<index> The index of the gpu to update
OPTIONS:
-h, --help Prints help information
--model The gpu model name
--vram The amount of gpu vram in Gb
rpk desktops gpu delUSAGE:
rpk desktops gpu del <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
<index> The index of the Gpu to remove
OPTIONS:
-h, --help Prints help information
rpk desktops nicUSAGE:
rpk desktops nic [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <desktop>
set <desktop> <index>
del <desktop> <index>
rpk desktops nic addUSAGE:
rpk desktops nic add <desktop> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
OPTIONS:
-h, --help Prints help information
--type The nic port type e.g rj45 / sfp+
--speed The port speed
--ports The number of ports
rpk desktops nic setUSAGE:
rpk desktops nic set <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
<index> The index of the nic to remove
OPTIONS:
-h, --help Prints help information
--type The nic port type e.g rj45 / sfp+
--speed The speed of the nic in Gb/s
--ports The number of ports
rpk desktops nic delUSAGE:
rpk desktops nic del <desktop> <index> [OPTIONS]
ARGUMENTS:
<desktop> The desktop name
<index> The index of the nic to remove
OPTIONS:
-h, --help Prints help information
rpk servicesDESCRIPTION:
Manage services
USAGE:
rpk services [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
summary Show service summary report
add <name> Add a new service
list List all services
get <name> Get a service by name
describe <name> Show detailed information about a service
set <name> Update service properties
del <name> Delete a service
rpk services summaryDESCRIPTION:
Show service summary report
USAGE:
rpk services summary [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk services addDESCRIPTION:
Add a new service
USAGE:
rpk services add <name> [OPTIONS]
ARGUMENTS:
<name> The name of the service
OPTIONS:
-h, --help Prints help information
rpk services listDESCRIPTION:
List all services
USAGE:
rpk services list [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk services getDESCRIPTION:
Get a service by name
USAGE:
rpk services get <name> [OPTIONS]
ARGUMENTS:
<name> The name of the service
OPTIONS:
-h, --help Prints help information
rpk services describeDESCRIPTION:
Show detailed information about a service
USAGE:
rpk services describe <name> [OPTIONS]
ARGUMENTS:
<name> The name of the service
OPTIONS:
-h, --help Prints help information
rpk services setDESCRIPTION:
Update service properties
USAGE:
rpk services set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--ip The ip address of the service
--port The port the service is running on
--protocol The service protocol
--url The service URL
--runs-on The system the service is running on
rpk services delDESCRIPTION:
Delete a service
USAGE:
rpk services del <name> [OPTIONS]
ARGUMENTS:
<name> The name of the service
OPTIONS:
-h, --help Prints help information
rpk apDESCRIPTION:
Show access point hardware report
USAGE:
rpk ap [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk serversDESCRIPTION:
Manage servers
USAGE:
rpk servers [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
summary Show a summarized hardware report for all servers
add <name> Add a new server
get <name> List servers or get a server by name
describe <name> Show detailed information about a server
set <name> Update server properties
del <name> Delete a server
tree <name> Displays a dependency tree for the server
cpu Manage server CPUs
drive Manage server drives
gpu Manage server GPUs
nic Manage server NICs
rpk servers summaryDESCRIPTION:
Show a summarized hardware report for all servers
USAGE:
rpk servers summary [OPTIONS]
OPTIONS:
-h, --help Prints help information
rpk servers addDESCRIPTION:
Add a new server
USAGE:
rpk servers add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk servers getDESCRIPTION:
List servers or get a server by name
USAGE:
rpk servers get <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk servers describeDESCRIPTION:
Show detailed information about a server
USAGE:
rpk servers describe <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk servers setDESCRIPTION:
Update server properties
USAGE:
rpk servers set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--ram <GB>
--ipmi
rpk servers delDESCRIPTION:
Delete a server
USAGE:
rpk servers del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk servers treeDESCRIPTION:
Displays a dependency tree for the server
USAGE:
rpk servers tree <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
rpk servers cpuDESCRIPTION:
Manage server CPUs
USAGE:
rpk servers cpu [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <name> Add a CPU to a server
set <name> Update a CPU on a server
del <name> Remove a CPU from a server
rpk servers cpu addDESCRIPTION:
Add a CPU to a server
USAGE:
rpk servers cpu add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--model <MODEL>
--cores <CORES>
--threads <THREADS>
rpk servers cpu setDESCRIPTION:
Update a CPU on a server
USAGE:
rpk servers cpu set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>
--model <MODEL>
--cores <CORES>
--threads <THREADS>
rpk servers cpu delDESCRIPTION:
Remove a CPU from a server
USAGE:
rpk servers cpu del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>
rpk servers driveDESCRIPTION:
Manage server drives
USAGE:
rpk servers drive [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <name> Add a drive to a server
set <name> Update a drive on a server
del <name> Remove a drive from a server
rpk servers drive addDESCRIPTION:
Add a drive to a server
USAGE:
rpk servers drive add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--type <TYPE>
--size <SIZE>
rpk servers drive setDESCRIPTION:
Update a drive on a server
USAGE:
rpk servers drive set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>
--type <TYPE>
--size <SIZE>
rpk servers drive delDESCRIPTION:
Remove a drive from a server
USAGE:
rpk servers drive del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>
rpk servers gpuDESCRIPTION:
Manage server GPUs
USAGE:
rpk servers gpu [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <name> Add a GPU to a server
set <name> Update a GPU on a server
del <name> Remove a GPU from a server
rpk servers gpu addDESCRIPTION:
Add a GPU to a server
USAGE:
rpk servers gpu add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--model <MODEL>
--vram <VRAM>
rpk servers gpu setDESCRIPTION:
Update a GPU on a server
USAGE:
rpk servers gpu set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>
--model <MODEL>
--vram <VRAM>
rpk servers gpu delDESCRIPTION:
Remove a GPU from a server
USAGE:
rpk servers gpu del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>
rpk servers nicDESCRIPTION:
Manage server NICs
USAGE:
rpk servers nic [OPTIONS] <COMMAND>
OPTIONS:
-h, --help Prints help information
COMMANDS:
add <name> Add a NIC to a server
set <name> Update a NIC on a server
del <name> Remove a NIC from a server
rpk servers nic addDESCRIPTION:
Add a NIC to a server
USAGE:
rpk servers nic add <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--type <TYPE>
--speed <SPEED>
--ports <PORTS>
rpk servers nic setDESCRIPTION:
Update a NIC on a server
USAGE:
rpk servers nic set <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>
--type <TYPE>
--speed <SPEED>
--ports <PORTS>
rpk servers nic delDESCRIPTION:
Remove a NIC from a server
USAGE:
rpk servers nic del <name> [OPTIONS]
ARGUMENTS:
<name>
OPTIONS:
-h, --help Prints help information
--index <INDEX>