@e4779/skills 0.0.0-stage → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/chrome-devtools/README.md +76 -0
  2. package/chrome-devtools/SKILL.md +277 -0
  3. package/chrome-devtools/references/recipes.md +379 -0
  4. package/chrome-devtools/references/setup.md +138 -0
  5. package/drawio/SKILL.md +395 -0
  6. package/gh-cli/SKILL.md +83 -0
  7. package/grill/SKILL.md +72 -0
  8. package/layout-check/README.md +32 -0
  9. package/layout-check/SKILL.md +416 -0
  10. package/layout-check/scripts/layoutProbe.mjs +539 -0
  11. package/mcpls/SKILL.md +261 -0
  12. package/mcpls/references/configuration.md +131 -0
  13. package/mcpls/references/install.md +13 -0
  14. package/mcporter/SKILL.md +90 -0
  15. package/mindmap/SKILL.md +46 -0
  16. package/mindmap/references/drawio-recipe.md +60 -0
  17. package/mindmap/references/mindmap-design.md +63 -0
  18. package/opensource-contribution/SKILL.md +119 -0
  19. package/package.json +33 -5
  20. package/shell-taste/.shellcheckrc +16 -0
  21. package/shell-taste/SKILL.md +95 -0
  22. package/shell-taste/references/handbook/dialects.md +168 -0
  23. package/shell-taste/references/handbook/dom/01-output-logging.md +245 -0
  24. package/shell-taste/references/handbook/dom/02-errors-exit.md +48 -0
  25. package/shell-taste/references/handbook/dom/03-installation-setup.md +179 -0
  26. package/shell-taste/references/handbook/dom/04-network.md +384 -0
  27. package/shell-taste/references/handbook/dom/05-files-paths.md +74 -0
  28. package/shell-taste/references/handbook/dom/06-checks-validation.md +127 -0
  29. package/shell-taste/references/handbook/dom/07-system-administration.md +103 -0
  30. package/shell-taste/references/handbook/dom/08-privilege-users.md +58 -0
  31. package/shell-taste/references/handbook/dom/09-text-data.md +62 -0
  32. package/shell-taste/references/handbook/dom/10-terminal-ux.md +60 -0
  33. package/shell-taste/references/handbook/dom/11-process-control.md +28 -0
  34. package/shell-taste/references/handbook/dom/12-uncategorized.md +161 -0
  35. package/shell-taste/references/handbook/dom/13-containers.md +13 -0
  36. package/shell-taste/references/handbook/dom/14-agents-ai-tooling.md +13 -0
  37. package/shell-taste/references/handbook/family-index.md +230 -0
  38. package/shell-taste/references/handbook/index.md +41 -0
  39. package/skill-author/SKILL.md +86 -0
  40. package/sobesednik/SKILL.md +98 -0
  41. package/sobesednik/card-template.md +23 -0
  42. package/sobesednik/personas/advocate.md +27 -0
  43. package/sobesednik/personas/analyst.md +29 -0
  44. package/sobesednik/personas/chat.md +42 -0
  45. package/sobesednik/personas/ifs.md +32 -0
  46. package/sobesednik/personas/journal/README.md +6 -0
  47. package/sobesednik/personas/nasreddin.md +29 -0
  48. package/sobesednik/personas/premortem.md +29 -0
  49. package/sobesednik/personas/rogers.md +27 -0
  50. package/sobesednik/personas/socratic.md +29 -0
  51. package/sobesednik/personas/stoic.md +27 -0
  52. package/sobesednik/references/persona-design.md +41 -0
  53. package/zai-mcp/README.md +63 -0
  54. package/zai-mcp/SKILL.md +160 -0
  55. package/zai-mcp/references/recipes.md +273 -0
  56. package/zai-mcp/references/tools.md +266 -0
  57. package/README.md +0 -3
@@ -0,0 +1,230 @@
1
+ <!-- GENERATED by shell-atlas bin/handbook (mk handbook). Hand edits WILL be overwritten. as-of: 5539bbbe9ebc 2026-11-08 -->
2
+
3
+ # Family index
4
+
5
+ One row per family name in |canon ∪ wild| (222 names). Grep by word root (name spaces differ between canon and wild) or by desc words. Anchor → dom page → record → live query / body.
6
+
7
+ | Family | kind | dom | units | projects | desc head |
8
+ |---|---|---|---|---|---|
9
+ | API Interaction | canon | [Installation & setup](dom/03-installation-setup.md#api-interaction) | 2 | 1 | API Interaction — Functions execute HTTP requests to external APIs using specific authentication and ... |
10
+ | API REST Call | canon | [Network](dom/04-network.md#api-rest-call) | 2 | 1 | API REST Call — Executes HTTP GET or POST requests to a specified API endpoint using exported headers. |
11
+ | API Rate Limit Handling | canon | [Network](dom/04-network.md#api-rate-limit-handling) | 2 | 1 | API Rate Limit Handling — Both functions implement logic to detect and recover from API rate limiting (429 Too Many ... |
12
+ | API Request Wrapper | wild | [Network](dom/04-network.md#api-request-wrapper) | 23 | 3 | API Request Wrapper — Executes a Docker container to perform a curl request to a specific internal service. |
13
+ | Abort and Exit | both | [Errors & exit](dom/02-errors-exit.md#abort-and-exit) | 10 | 5 | Abort and Exit — Exits the script with a failure status after notifying the user that no changes were made. |
14
+ | App Setup Menu | canon | [Installation & setup](dom/03-installation-setup.md#app-setup-menu) | 44 | 1 | App Setup Menu — Presents a menu to choose between installing, uninstalling, or managing a specific ... |
15
+ | Argument Parsing | wild | [Uncategorized](dom/12-uncategorized.md#argument-parsing) | 10 | 9 | Argument Parsing — These functions parse and command-line arguments to set variables and handle flags. |
16
+ | Around Execution Hooks | canon | [Uncategorized](dom/12-uncategorized.md#around-execution-hooks) | 2 | 1 | Around Execution Hooks — Wraps function execution to execute setup and teardown hooks before and after the main ... |
17
+ | Assertion Testing | wild | [Checks & validation](dom/06-checks-validation.md#assertion-testing) | 6 | 4 | Assertion Testing — Both functions provide a way to check for equality between two values and report a ... |
18
+ | Attribute Getter | canon | [Uncategorized](dom/12-uncategorized.md#attribute-getter) | 2 | 1 | Attribute Getter — Retrieves a specific attribute value from a defined file path structure. |
19
+ | Autodns Zone Management | canon | [Network](dom/04-network.md#autodns-zone-management) | 4 | 1 | Autodns Zone Management — This family manages the process of querying, retrieving, updating, and cleaning up DNS ... |
20
+ | BBR Congestion Control | wild | [Network](dom/04-network.md#bbr-congestion-control) | 9 | 5 | BBR Congestion Control — These functions configure and enable the BBR TCP congestion control algorithm on the ... |
21
+ | Banner Display | wild | [Output & logging](dom/01-output-logging.md#banner-display) | 18 | 13 | Banner Display — These functions are part of a cluster of shell scripts that display a ASCII art banner ... |
22
+ | Build Script Generation | wild | [Network](dom/04-network.md#build-script-generation) | 5 | 5 | Build Script Generation — These functions perform a repository-wide build process, either by invoking a makefile or ... |
23
+ | Build XML API Requests | canon | [Network](dom/04-network.md#build-xml-api-requests) | 3 | 1 | Build XML API Requests — Functions construct specific XML payloads for various ACME DNS API operations. |
24
+ | Calculate SHA-256 hash | wild | [Uncategorized](dom/12-uncategorized.md#calculate-sha-256-hash) | 5 | 5 | Calculate SHA-256 hash — The function computes the SHA-256 checksum of a file and returns the output. |
25
+ | Case Conversion | canon | [Text & data](dom/09-text-data.md#case-conversion) | 2 | 1 | Case Conversion — Converts the case of input strings between upper and lower using `tr` |
26
+ | Certificate Generation | canon | [Uncategorized](dom/12-uncategorized.md#certificate-generation) | 2 | 1 | Certificate Generation — Creates server and CA certificates using certutil for IKEv2 VPN setup. |
27
+ | Check Certificate Existence | canon | [Checks & validation](dom/06-checks-validation.md#check-certificate-existence) | 4 | 1 | Check Certificate Existence — Verifies if a specified certificate name is present in the configured certificate ... |
28
+ | Check File Descriptor Usage | canon | [Network](dom/04-network.md#check-file-descriptor-usage) | 2 | 1 | Check File Descriptor Usage — Validates if file descriptors are used correctly within the shellspec DSL context. |
29
+ | Check IPsec VPN Prerequisites | canon | [Checks & validation](dom/06-checks-validation.md#check-ipsec-vpn-prerequisites) | 29 | 1 | Check IPsec VPN Prerequisites — Verifies necessary software, configuration files, and service states for IPsec VPN setup. |
30
+ | Check LXC Environment | canon | [Installation & setup](dom/03-installation-setup.md#check-lxc-environment) | 3 | 1 | Check LXC Environment — Verifies if the required /dev/ppp device exists when the container type is set to lxc. |
31
+ | Check OpenVZ Support | canon | [Network](dom/04-network.md#check-openvz-support) | 8 | 1 | Check OpenVZ Support — Verifies if the system is running on OpenVZ by checking for the presence of ... |
32
+ | Check Required Utilities | canon | [Checks & validation](dom/06-checks-validation.md#check-required-utilities) | 2 | 1 | Check Required Utilities — Verifies the presence of necessary cryptographic and utility commands using `command -v` ... |
33
+ | Check Root Privileges | canon | [Privilege & users](dom/08-privilege-users.md#check-root-privileges) | 12 | 1 | Check Root Privileges — Ensures the script is executed with root privileges by checking the user ID. |
34
+ | Check System Managers | canon | [System administration](dom/07-system-administration.md#check-system-managers) | 2 | 1 | Check System Managers — Determines and validates the presence of required system components like package managers ... |
35
+ | Check Temporary Status | canon | [Output & logging](dom/01-output-logging.md#check-temporary-status) | 2 | 1 | Check Temporary Status — Determines if a shellspec is marked as temporary based on specific environment variables. |
36
+ | Check VPN Subnets | canon | [Network](dom/04-network.md#check-vpn-subnets) | 3 | 1 | Check VPN Subnets — Verifies that required custom VPN subnets are correctly configured in ipsec.conf. |
37
+ | Check and Fetch Leapfile | canon | [Checks & validation](dom/06-checks-validation.md#check-and-fetch-leapfile) | 2 | 1 | Check and Fetch Leapfile — Determines if an NTP leapfile needs updating and fetches it if necessary. |
38
+ | Check and Select MOBIKE Support | canon | [Network](dom/04-network.md#check-and-select-mobike-support) | 2 | 1 | Check and Select MOBIKE Support — Determines if the system supports MOBIKE and prompts the user to enable it for IPsec VPN ... |
39
+ | Check poudriere run type | canon | [Checks & validation](dom/06-checks-validation.md#check-poudriere-run-type) | 2 | 1 | Check poudriere run type — Determines if the script was executed as a bulk run or a testport run based on the ... |
40
+ | Client Credential Validation | canon | [Checks & validation](dom/06-checks-validation.md#client-credential-validation) | 7 | 1 | Client Credential Validation — Functions validate the format and range of client names and associated numerical ... |
41
+ | Client Status Print | canon | [Output & logging](dom/01-output-logging.md#client-status-print) | 2 | 1 | Client Status Print — Prints a message indicating the status (revoked or deleted) of a specified client. |
42
+ | Client VPN Management | canon | [Network](dom/04-network.md#client-vpn-management) | 4 | 1 | Client VPN Management — Functions manage the display and setup of IKEv2 VPN clients. |
43
+ | Clone Git Repository | canon | [Files & paths](dom/05-files-paths.md#clone-git-repository) | 2 | 1 | Clone Git Repository — Downloads and copies configuration files from a specified Git repository to designated ... |
44
+ | Clone Shell Variable | canon | [Terminal UX](dom/10-terminal-ux.md#clone-shell-variable) | 11 | 1 | Clone Shell Variable — This function processes and sets variables by parsing colon-separated key-value pairs. |
45
+ | Colorized Output | wild | [Output & logging](dom/01-output-logging.md#colorized-output) | 21 | 12 | Colorized Output — These functions provide a ANSI escape code for red text output in a shell script. |
46
+ | Command Availability Check | wild | [Checks & validation](dom/06-checks-validation.md#command-availability-check) | 7 | 6 | Command Availability Check — Verifies if a specific command exists in the system's PATH. |
47
+ | Command Execution Wrapper | wild | [Uncategorized](dom/12-uncategorized.md#command-execution-wrapper) | 81 | 7 | Command Execution Wrapper — These functions provide a mechanism to ensure safe and controlled execution of shell ... |
48
+ | Command Existence Check | wild | [Checks & validation](dom/06-checks-validation.md#command-existence-check) | 24 | 18 | Command Existence Check — These functions verify if a specific command or executable is available in the system's ... |
49
+ | Command existence check | wild | [Checks & validation](dom/06-checks-validation.md#command-existence-check) | 9 | 9 | Command existence check — These functions check if a specific command exists in the path. |
50
+ | Configuration Backup | canon | [Files & paths](dom/05-files-paths.md#configuration-backup) | 7 | 1 | Configuration Backup — This function backs up a configuration file by appending a timestamp to the filename. |
51
+ | Configuration File Writing | wild | [Files & paths](dom/05-files-paths.md#configuration-file-writing) | 6 | 3 | Configuration File Writing — Both functions perform the task of saving configuration parameters or installation ... |
52
+ | Configure Fail2Ban | canon | [Errors & exit](dom/02-errors-exit.md#configure-fail2ban) | 4 | 1 | Configure Fail2Ban — Installs and configures Fail2Ban to protect SSH services. |
53
+ | Configure IPsec VPN | canon | [Network](dom/04-network.md#configure-ipsec-vpn) | 11 | 1 | Configure IPsec VPN — Sets up various components and configurations for an IPsec VPN connection. |
54
+ | Configure VPN Server Address | canon | [Network](dom/04-network.md#configure-vpn-server-address) | 5 | 1 | Configure VPN Server Address — Prompts the user to input or confirm the server's IP address or DNS name for IKEv2 VPN ... |
55
+ | Confirm Exit | wild | [Errors & exit](dom/02-errors-exit.md#confirm-exit) | 8 | 2 | Confirm Exit — The function provides a user confirmation prompt before exiting a process. |
56
+ | Container Flag Generator | canon | [Containers](dom/13-containers.md#container-flag-generator) | 2 | 1 | Container Flag Generator — Generates a space-separated list of container management flags based on the operating ... |
57
+ | Create temporary file | canon | [Files & paths](dom/05-files-paths.md#create-temporary-file) | 2 | 1 | Create temporary file — Generates a uniquely named temporary file and stores its path for subsequent use. |
58
+ | Cross-platform Package Manager | wild | [System administration](dom/07-system-administration.md#cross-platform-package-manager) | 11 | 4 | Cross-platform Package Manager — These functions install software packages across multiple Linux distributions and macOS. |
59
+ | DNS API record retrieval | canon | [Network](dom/04-network.md#dns-api-record-retrieval) | 2 | 1 | DNS API record retrieval — Functions retrieve specific DNS records or zone IDs from a cloud provider's API. |
60
+ | DNS Record Management | canon | [Installation & setup](dom/03-installation-setup.md#dns-record-management) | 73 | 1 | DNS Record Management — Functions manage the creation and deletion of DNS TXT records across various providers. |
61
+ | DNS Selectel Management | canon | [Network](dom/04-network.md#dns-selectel-management) | 2 | 1 | DNS Selectel Management — Functions for adding or removing DNS selectel records for a given domain. |
62
+ | Database Readiness Check | wild | [Checks & validation](dom/06-checks-validation.md#database-readiness-check) | 7 | 4 | Database Readiness Check — These functions verify if a PostgreSQL database container is ready to accept connections ... |
63
+ | Debug Logging | both | [Output & logging](dom/01-output-logging.md#debug-logging) | 11 | 10 | Debug Logging — This function conditionally executes various logging mechanisms (standard, syslog, and ... |
64
+ | Debug Logging Function | canon | [Output & logging](dom/01-output-logging.md#debug-logging-function) | 4 | 1 | Debug Logging Function — This function conditionally logs arguments and hidden values based on various environment ... |
65
+ | Dependency Checking | wild | [Checks & validation](dom/06-checks-validation.md#dependency-checking) | 6 | 6 | Dependency Checking — These functions verify and install required software components to ensure the environment ... |
66
+ | Dependency Validation | wild | [Checks & validation](dom/06-checks-validation.md#dependency-validation) | 9 | 3 | Dependency Validation — These functions check for the existence of which required components (variables or ... |
67
+ | Detect IPv6 Address | canon | [Network](dom/04-network.md#detect-ipv6-address) | 3 | 1 | Detect IPv6 Address — The function determines and validates the primary IPv6 address for VPN setup using ... |
68
+ | Detect Public IP | canon | [Network](dom/04-network.md#detect-public-ip) | 3 | 1 | Detect Public IP — This function attempts to determine the server's public IP address, prioritizing a ... |
69
+ | Determine and Select Password Usage | canon | [Uncategorized](dom/12-uncategorized.md#determine-and-select-password-usage) | 2 | 1 | Determine and Select Password Usage — These functions check for and prompt the user to determine if an IPsec VPN configuration ... |
70
+ | Directory Empty Check | wild | [Checks & validation](dom/06-checks-validation.md#directory-empty-check) | 11 | 2 | Directory Empty Check — These functions check if a directory is empty or not. |
71
+ | Directory Path Validation | wild | [Checks & validation](dom/06-checks-validation.md#directory-path-validation) | 11 | 2 | Directory Path Validation — These functions verify and set the environment's directory paths or ensure their ... |
72
+ | Display Header | wild | [Output & logging](dom/01-output-logging.md#display-header) | 23 | 19 | Display Header — These functions are used to print a decorative header or introductory text to the user. |
73
+ | Display Help | wild | [Output & logging](dom/01-output-logging.md#display-help) | 6 | 5 | Display Help — These functions provide usage instructions and command-line options for a script. |
74
+ | Display Help Information | wild | [Output & logging](dom/01-output-logging.md#display-help-information) | 6 | 2 | Display Help Information — These functions provide usage instructions and command-line options for their respective ... |
75
+ | Docker Installation | wild | [Installation & setup](dom/03-installation-setup.md#docker-installation) | 14 | 7 | Docker Installation — The functions provide logic to either install the Docker engine or pull a pre-defined ... |
76
+ | Dump Shellspec Details | canon | [Terminal UX](dom/10-terminal-ux.md#dump-shellspec-details) | 2 | 1 | Dump Shellspec Details — Reports the contents and status of the shellspec specification file and its associated ... |
77
+ | Dynamic Theme Color Updating | wild | [Output & logging](dom/01-output-logging.md#dynamic-theme-color-updating) | 76 | 2 | Dynamic Theme Color Updating — The functions update configuration files for polybar and rofi to apply new color schemes. |
78
+ | Enable VPN Services | canon | [Network](dom/04-network.md#enable-vpn-services) | 3 | 1 | Enable VPN Services — Configures necessary services and startup scripts to ensure the IPsec VPN is active on ... |
79
+ | Environment Directory Setup | canon | [Installation & setup](dom/03-installation-setup.md#environment-directory-setup) | 2 | 1 | Environment Directory Setup — Creates a directory and populates it with environment variables from the current shell ... |
80
+ | Environment Variable Expansion | wild | [Installation & setup](dom/03-installation-setup.md#environment-variable-expansion) | 16 | 4 | Environment Variable Expansion — These functions allow a user to define a system variable or a file path to its value, ... |
81
+ | Error Handling Function | canon | [Errors & exit](dom/02-errors-exit.md#error-handling-function) | 16 | 2 | Error Handling Function — Provides a standardized way to print an error message and exit the script with a failure ... |
82
+ | Error reporting | wild | [Errors & exit](dom/02-errors-exit.md#error-reporting) | 297 | 119 | Error reporting — These functions provide a user-friendly way to send a user-friendly way to send a ... |
83
+ | Evaluate Function Call | canon | [Uncategorized](dom/12-uncategorized.md#evaluate-function-call) | 5 | 1 | Evaluate Function Call — Executes a function call while managing error handling and tracing options. |
84
+ | Execution Wrapper | wild | [Uncategorized](dom/12-uncategorized.md#execution-wrapper) | 10 | 7 | Execution Wrapper — These functions provide a standardized interface for executing commands or scripts, ... |
85
+ | Extract NTP Leapfile Metadata | canon | [Files & paths](dom/05-files-paths.md#extract-ntp-leapfile-metadata) | 2 | 1 | Extract NTP Leapfile Metadata — Extracts specific version or expiry dates from an NTP leapfile using awk and regex ... |
86
+ | Fetch latest release | wild | [Installation & setup](dom/03-installation-setup.md#fetch-latest-release) | 15 | 12 | Fetch latest release — Retrieves the latest version tag or name from a GitHub repository. |
87
+ | Fetching Run Counts | wild | [Text & data](dom/09-text-data.md#fetching-run-counts) | 5 | 5 | Fetching Run Counts — Both functions retrieve and parse numerical data from a remote URL to update local ... |
88
+ | File Download Utility | wild | [Network](dom/04-network.md#file-download-utility) | 32 | 19 | File Download Utility — Both functions are designed to automate the user-based selection and retrieval of remote ... |
89
+ | File Extraction | wild | [Files & paths](dom/05-files-paths.md#file-extraction) | 8 | 6 | File Extraction — These functions handle the decompression and extraction of various archive formats (e.g., ... |
90
+ | File Size Retrieval | wild | [Files & paths](dom/05-files-paths.md#file-size-retrieval) | 5 | 3 | File Size Retrieval — These functions calculate and return the size of a file in bytes. |
91
+ | Find Local Startup Scripts | canon | [Network](dom/04-network.md#find-local-startup-scripts) | 2 | 1 | Find Local Startup Scripts — Locates executable shell scripts within specified local startup directories. |
92
+ | Fix GCP MTU | canon | [Uncategorized](dom/12-uncategorized.md#fix-gcp-mtu) | 2 | 1 | Fix GCP MTU — Sets the network interface MTU to 1500 and updates the dhclient configuration file for ... |
93
+ | Fix NSS Configuration | canon | [Uncategorized](dom/12-uncategorized.md#fix-nss-configuration) | 2 | 1 | Fix NSS Configuration — Ensures required cryptographic algorithms are present in the system's NSS configuration ... |
94
+ | Format Message Output | canon | [Output & logging](dom/01-output-logging.md#format-message-output) | 2 | 1 | Format Message Output — Formats and prints messages with optional elapsed time and color support |
95
+ | Get Attributes | canon | [Uncategorized](dom/12-uncategorized.md#get-attributes) | 3 | 1 | Get Attributes — Retrieves specified attributes from a package set or package. |
96
+ | Get Build Data | canon | [Uncategorized](dom/12-uncategorized.md#get-build-data) | 2 | 1 | Get Build Data — Retrieves a list of build-related data from a specified file path. |
97
+ | Get Network IP Addresses | canon | [Network](dom/04-network.md#get-network-ip-addresses) | 10 | 1 | Get Network IP Addresses — Retrieves either the public or default local IP address using various system tools and ... |
98
+ | Get Server IP | canon | [Output & logging](dom/01-output-logging.md#get-server-ip) | 2 | 1 | Get Server IP — Determines the server's public IP address, prioritizing configured variables or default ... |
99
+ | Get Setup URL | canon | [Network](dom/04-network.md#get-setup-url) | 2 | 1 | Get Setup URL — Determines and constructs the correct download URL for the IPsec VPN setup script based ... |
100
+ | Get total updates | wild | [System administration](dom/07-system-administration.md#get-total-updates) | 21 | 2 | Get total updates — The function retrieves the count of pending system updates. |
101
+ | Go Environment Setup | wild | [Installation & setup](dom/03-installation-setup.md#go-environment-setup) | 8 | 2 | Go Environment Setup — These functions are designed to handle the installation and configuration of the ... |
102
+ | Handle installation failure | canon | [Errors & exit](dom/02-errors-exit.md#handle-installation-failure) | 6 | 1 | Handle installation failure — This function reports a failure during package installation using different package ... |
103
+ | Handle user confirmation | canon | [Privilege & users](dom/08-privilege-users.md#handle-user-confirmation) | 3 | 1 | Handle user confirmation — Prompts the user for confirmation and aborts if the input is not affirmative. |
104
+ | IP Address Validation | wild | [Network](dom/04-network.md#ip-address-validation) | 10 | 3 | IP Address Validation — Both functions verify the existence and format of an IP address, either by retrieving it ... |
105
+ | IPv6 Availability Check | wild | [Network](dom/04-network.md#ipv6-availability-check) | 5 | 3 | IPv6 Availability Check — The functions detect whether IPv6 is available or configured for use in a network ... |
106
+ | IPv6 Network Configuration | wild | [Network](dom/04-network.md#ipv6-network-configuration) | 5 | 2 | IPv6 Network Configuration — These functions perform validation and probing of Proxmox VE network interfaces and IPv6 ... |
107
+ | Install Application | canon | [Installation & setup](dom/03-installation-setup.md#install-application) | 84 | 1 | Install Application — Installs specified software packages using detected system package managers. |
108
+ | Install Application Files | canon | [Installation & setup](dom/03-installation-setup.md#install-application-files) | 2 | 1 | Install Application Files — Downloads and places necessary application files like manpages and desktop entries to ... |
109
+ | Install Communication Apps | canon | [Installation & setup](dom/03-installation-setup.md#install-communication-apps) | 2 | 1 | Install Communication Apps — Installs specified communication applications using package managers like pacman or ... |
110
+ | Install Container Compose | canon | [Installation & setup](dom/03-installation-setup.md#install-container-compose) | 3 | 1 | Install Container Compose — Installs the appropriate container orchestration tool (Docker Compose or Podman Compose) ... |
111
+ | Install Developer IDE | canon | [Installation & setup](dom/03-installation-setup.md#install-developer-ide) | 2 | 1 | Install Developer IDE — Installs either VS Code or VS Codium using system package managers (apt, zypper, pacman, ... |
112
+ | Install PDF Components | canon | [Installation & setup](dom/03-installation-setup.md#install-pdf-components) | 2 | 1 | Install PDF Components — Checks for and installs specific PDF-related applications from remote scripts. |
113
+ | Install UUID Generator | canon | [Installation & setup](dom/03-installation-setup.md#install-uuid-generator) | 2 | 1 | Install UUID Generator — Ensures the `uuidgen` command is available by installing necessary packages based on the ... |
114
+ | Install VPN Dependencies | canon | [Network](dom/04-network.md#install-vpn-dependencies) | 12 | 1 | Install VPN Dependencies — Installs necessary operating system packages required for setting up an IPsec VPN. |
115
+ | Interact with IONOS APIs | canon | [Network](dom/04-network.md#interact-with-ionos-apis) | 2 | 1 | Interact with IONOS APIs — Executes HTTP requests (GET/POST) to specific IONOS API endpoints using credentials and ... |
116
+ | Interactive Installer | wild | [Installation & setup](dom/03-installation-setup.md#interactive-installer) | 64 | 17 | Interactive Installer — These functions perform a user- or user-selected option-based installation or ... |
117
+ | Interactive Menu Display | wild | [Output & logging](dom/01-output-logging.md#interactive-menu-display) | 32 | 17 | Interactive Menu Display — These functions present a user-oriented menu for selecting options or actions within a ... |
118
+ | Interface Validation | canon | [Network](dom/04-network.md#interface-validation) | 5 | 1 | Interface Validation — Checks if the default network interface is active and not a wireless adapter to prevent ... |
119
+ | JSON String Formatting | wild | [Text & data](dom/09-text-data.md#json-string-formatting) | 10 | 2 | JSON String Formatting — These functions convert a single input string into a JSON-quoted string. |
120
+ | Jail attribute access | canon | [Agents & AI tooling](dom/14-agents-ai-tooling.md#jail-attribute-access) | 3 | 1 | Jail attribute access — Functions provide set and get operations for jail attributes. |
121
+ | Job Message Logging | canon | [Output & logging](dom/01-output-logging.md#job-message-logging) | 8 | 1 | Job Message Logging — Functions provide colored, level-specific logging for job status and messages to stderr. |
122
+ | Job Warning Message | canon | [Output & logging](dom/01-output-logging.md#job-warning-message) | 2 | 1 | Job Warning Message — Prints a warning message prefixed with a specific color and label. |
123
+ | Kernel Build Script | wild | [Network](dom/04-network.md#kernel-build-script) | 10 | 2 | Kernel Build Script — The functions perform a sequence of configuration and compilation steps to build a kernel ... |
124
+ | LA API Setup | canon | [Network](dom/04-network.md#la-api-setup) | 2 | 1 | LA API Setup — Sets up the necessary authorization token and performs API requests using the token. |
125
+ | Level27 API Interaction | canon | [Network](dom/04-network.md#level27-api-interaction) | 2 | 1 | Level27 API Interaction — Manages API key setup and executes REST API calls to the Level27 DNS service. |
126
+ | Libreswan Setup | canon | [Installation & setup](dom/03-installation-setup.md#libreswan-setup) | 12 | 1 | Libreswan Setup — Downloads, extracts, and configures the Libreswan VPN package for installation. |
127
+ | Logging Output | canon | [Output & logging](dom/01-output-logging.md#logging-output) | 2 | 2 | Logging Output — Functions write variable or positional arguments to a specified log file or standard ... |
128
+ | Logging Success | wild | [Output & logging](dom/01-output-logging.md#logging-success) | 20 | 16 | Logging Success — These functions provide a formatted output for reporting successful operations. |
129
+ | Logging Warnings | wild | [Output & logging](dom/01-output-logging.md#logging-warnings) | 76 | 50 | Logging Warnings — These functions are part of a cluster of shell scripts that provide standardized logging ... |
130
+ | Logging Wrapper | wild | [Output & logging](dom/01-output-logging.md#logging-wrapper) | 16 | 2 | Logging Wrapper — These functions provide a conditional logging mechanism that only prints output if a ... |
131
+ | Logging and Display | wild | [Output & logging](dom/01-output-logging.md#logging-and-display) | 18 | 9 | Logging and Display — These functions provide a formatted output for status messages or status updates. |
132
+ | Logging and Formatting | wild | [Output & logging](dom/01-output-logging.md#logging-and-formatting) | 12 | 10 | Logging and Formatting — These functions provide a stylized, and a consistent way to provide visual feedback to ... |
133
+ | Logging and Output | wild | [Output & logging](dom/01-output-logging.md#logging-and-output) | 124 | 71 | Logging and Output — These functions provide a formatted output for messages, appending to a file or printing ... |
134
+ | Logging and Skipping | wild | [Output & logging](dom/01-output-logging.md#logging-and-skipping) | 27 | 8 | Logging and Skipping — These functions provide a loop-based skipping mechanism that prints a status message and ... |
135
+ | Manage Client Certificates | canon | [Uncategorized](dom/12-uncategorized.md#manage-client-certificates) | 6 | 1 | Manage Client Certificates — This family of functions handles the creation, deletion, and management of client ... |
136
+ | Manage DNS records | canon | [Network](dom/04-network.md#manage-dns-records) | 2 | 1 | Manage DNS records — Adds or removes a specific TXT record for ACME challenge verification on a given domain. |
137
+ | Manage IKEv2-only mode | canon | [Uncategorized](dom/12-uncategorized.md#manage-ikev2-only-mode) | 5 | 1 | Manage IKEv2-only mode — Controls the enabling or disabling of IKEv2-only mode for the VPN server. |
138
+ | Manage Scaleway TXT Records | canon | [Uncategorized](dom/12-uncategorized.md#manage-scaleway-txt-records) | 2 | 1 | Manage Scaleway TXT Records — These functions perform creation and deletion of TXT records within a specified DNS zone ... |
139
+ | Manage VPN Helper Scripts | canon | [Network](dom/04-network.md#manage-vpn-helper-scripts) | 4 | 1 | Manage VPN Helper Scripts — Downloads and links necessary scripts for IPsec VPN setup from remote sources. |
140
+ | Manage VPN Users | canon | [Privilege & users](dom/08-privilege-users.md#manage-vpn-users) | 2 | 1 | Manage VPN Users — The functions ensure the necessary IPsec VPN environment is set up and then manage user ... |
141
+ | Manage p12 password | canon | [Uncategorized](dom/12-uncategorized.md#manage-p12-password) | 2 | 1 | Manage p12 password — Retrieves or generates the password required for the p12 file used in IKEv2 setup |
142
+ | Message Formatting | canon | [Output & logging](dom/01-output-logging.md#message-formatting) | 2 | 1 | Message Formatting — Functions format and output messages using a common internal helper function. |
143
+ | Mock File Generation | canon | [Files & paths](dom/05-files-paths.md#mock-file-generation) | 4 | 1 | Mock File Generation — This family of functions manages the creation, content generation, and cleanup of mock ... |
144
+ | Network Information Retrieval | wild | [Output & logging](dom/01-output-logging.md#network-information-retrieval) | 15 | 11 | Network Information Retrieval — These functions retrieve external IP addresses or server metadata from remote endpoints. |
145
+ | Network Interface Detection | wild | [Network](dom/04-network.md#network-interface-detection) | 6 | 2 | Network Interface Detection — The function identifies the default network interface and ensures it is not a wireless ... |
146
+ | Network Parameter Validation | canon | [Network](dom/04-network.md#network-parameter-validation) | 26 | 1 | Network Parameter Validation — Checks if provided arguments are valid IP addresses, fully qualified domain names, or ... |
147
+ | Nginx Configuration Template Substitution | wild | [Files & paths](dom/05-files-paths.md#nginx-configuration-template-substitution) | 6 | 2 | Nginx Configuration Template Substitution — The function performs environment variable substitution into Nginx configuration ... |
148
+ | OS Detection | wild | [System administration](dom/07-system-administration.md#os-detection) | 8 | 6 | OS Detection — These functions identify the operating system and package manager of the host system. |
149
+ | OS Environment Detection | canon | [System administration](dom/07-system-administration.md#os-environment-detection) | 11 | 1 | OS Environment Detection — Determines the operating system type and version from standard Linux files. |
150
+ | Operating System Detection | wild | [System administration](dom/07-system-administration.md#operating-system-detection) | 12 | 2 | Operating System Detection — These functions identify the operating system and its specific version or environment to ... |
151
+ | Port Input Handling | wild | [Network](dom/04-network.md#port-input-handling) | 5 | 4 | Port Input Handling — These functions are designed to handle the user input or extraction of port numbers from ... |
152
+ | Process Spinner | wild | [Process control](dom/11-process-control.md#process-spinner) | 5 | 3 | Process Spinner — Displays a visual loading indicator while monitoring a background process's status. |
153
+ | Process list of options | canon | [Process control](dom/11-process-control.md#process-list-of-options) | 2 | 1 | Process list of options — Iterates through provided arguments to build internal lists of paths or options. |
154
+ | Prompt Continuation Check | canon | [Checks & validation](dom/06-checks-validation.md#prompt-continuation-check) | 2 | 2 | Prompt Continuation Check — Determines if the user wishes to continue execution after a task completes. |
155
+ | Quote Stripping Functions | canon | [Network](dom/04-network.md#quote-stripping-functions) | 2 | 1 | Quote Stripping Functions — These functions remove surrounding quotes (single or double) from a string argument. |
156
+ | Rackspace API Interaction | canon | [Network](dom/04-network.md#rackspace-api-interaction) | 3 | 1 | Rackspace API Interaction — Functions manage authentication and make API calls to Rackspace services. |
157
+ | Random String Generation | wild | [Text & data](dom/09-text-data.md#random-string-generation) | 6 | 6 | Random String Generation — These functions generate random alphanumeric or ASCII strings of a specified length. |
158
+ | Reboot Prompt | wild | [Terminal UX](dom/10-terminal-ux.md#reboot-prompt) | 6 | 3 | Reboot Prompt — The function prompts the user to reboot the system and handles the input to trigger a ... |
159
+ | Remote Resource Acquisition | wild | [Uncategorized](dom/12-uncategorized.md#remote-resource-acquisition) | 15 | 7 | Remote Resource Acquisition — These functions perform the downloading and extraction of remote files or directories ... |
160
+ | Removal Status Printer | canon | [Output & logging](dom/01-output-logging.md#removal-status-printer) | 2 | 1 | Removal Status Printer — Prints a confirmation message indicating that a specific VPN component has been removed. |
161
+ | Remove IKEv2 Configuration | canon | [Uncategorized](dom/12-uncategorized.md#remove-ikev2-configuration) | 2 | 1 | Remove IKEv2 Configuration — Deletes the IKEv2 configuration file after confirming the action. |
162
+ | Remove Records | canon | [Uncategorized](dom/12-uncategorized.md#remove-records) | 2 | 1 | Remove Records — Filters a file based on a record prefix and updates the original file with the filtered ... |
163
+ | Remove VPN Components | canon | [Network](dom/04-network.md#remove-vpn-components) | 3 | 1 | Remove VPN Components — Cleans up configuration files and directories related to IPsec and VPN services. |
164
+ | Resource Name Validation | wild | [Checks & validation](dom/06-checks-validation.md#resource-name-validation) | 9 | 4 | Resource Name Validation — These functions validate the naming conventions and availability of cloud resources ... |
165
+ | Restart IPsec Service | canon | [Network](dom/04-network.md#restart-ipsec-service) | 6 | 1 | Restart IPsec Service — This function restarts the IPsec service using the standard `service` command. |
166
+ | Retrieve Public IP | wild | [Network](dom/04-network.md#retrieve-public-ip) | 10 | 5 | Retrieve Public IP — The function retrieves the public IPv4 address of the host system using multiple external ... |
167
+ | Retrieve tmux options | wild | [Terminal UX](dom/10-terminal-ux.md#retrieve-tmux-options) | 9 | 7 | Retrieve tmux options — These functions fetch the global configuration value of a tmux option and return the ... |
168
+ | Root Privilege Check | wild | [Privilege & users](dom/08-privilege-users.md#root-privilege-check) | 57 | 17 | Root Privilege Check — The functions verify if the current user has root privileges and exit if not. |
169
+ | Run Hook | canon | [Uncategorized](dom/12-uncategorized.md#run-hook) | 2 | 1 | Run Hook — Executes custom logic during the build process based on specified hooks and events |
170
+ | Script Update Manager | wild | [Network](dom/04-network.md#script-update-manager) | 8 | 2 | Script Update Manager — These functions are designed to check for and download the new version of a shell script ... |
171
+ | Script Usage Display | wild | [Output & logging](dom/01-output-logging.md#script-usage-display) | 693 | 220 | Script Usage Display — These functions provide instructions on how to users can use the shell scripts. |
172
+ | Select IKEv2 Client Name | canon | [Uncategorized](dom/12-uncategorized.md#select-ikev2-client-name) | 3 | 1 | Select IKEv2 Client Name — Prompts the user to input and validate an existing IKEv2 client name for subsequent ... |
173
+ | Select Menu Option | canon | [Output & logging](dom/01-output-logging.md#select-menu-option) | 2 | 1 | Select Menu Option — Presents a numbered menu and validates user input against a predefined set of choices. |
174
+ | Selfhost DNS API Interaction | canon | [Network](dom/04-network.md#selfhost-dns-api-interaction) | 2 | 1 | Selfhost DNS API Interaction — Functions interact with a self-hosted DNS API to manage records. |
175
+ | Service Lifecycle Management | canon | [System administration](dom/07-system-administration.md#service-lifecycle-management) | 5 | 1 | Service Lifecycle Management — Functions provide standardized wrappers for starting, stopping, enabling, and disabling ... |
176
+ | Service Shutdown | wild | [System administration](dom/07-system-administration.md#service-shutdown) | 29 | 10 | Service Shutdown — These functions perform the shutdown of a specific service or process by identifying its ... |
177
+ | Set Shellspec Context | canon | [Terminal UX](dom/10-terminal-ux.md#set-shellspec-context) | 2 | 1 | Set Shellspec Context — These functions initialize and configure environment variables required for shellspec ... |
178
+ | Set Shellspec IDs | canon | [Terminal UX](dom/10-terminal-ux.md#set-shellspec-ids) | 2 | 1 | Set Shellspec IDs — Functions set global variables representing group and example identifiers within a ... |
179
+ | Set up IKEv2 VPN | canon | [Network](dom/04-network.md#set-up-ikev2-vpn) | 3 | 1 | Set up IKEv2 VPN — This function checks if IKEv2 is needed and runs a script to configure the VPN if it ... |
180
+ | Setup Fastfetch | canon | [Installation & setup](dom/03-installation-setup.md#setup-fastfetch) | 3 | 1 | Setup Fastfetch — Installs Fastfetch using system package managers and sets up default configuration files. |
181
+ | Setup IPsec VPN Links | canon | [Network](dom/04-network.md#setup-ipsec-vpn-links) | 3 | 1 | Setup IPsec VPN Links — This function prepares and links necessary scripts for IPsec VPN operation from source ... |
182
+ | Setup RetroArch | canon | [Installation & setup](dom/03-installation-setup.md#setup-retroarch) | 2 | 1 | Setup RetroArch — Installs and configures the RetroArch emulator and its necessary libretro cores across ... |
183
+ | Shellspec DSL Invocation | canon | [Terminal UX](dom/10-terminal-ux.md#shellspec-dsl-invocation) | 2 | 1 | Shellspec DSL Invocation — Executes and validates a defined shell specification using helper functions. |
184
+ | Shellspec Evaluation | canon | [Terminal UX](dom/10-terminal-ux.md#shellspec-evaluation) | 4 | 1 | Shellspec Evaluation — Functions evaluate shellspec content sourced from different standard input mechanisms ... |
185
+ | Show VPN Setup Status | canon | [Output & logging](dom/01-output-logging.md#show-vpn-setup-status) | 3 | 1 | Show VPN Setup Status — Displays confirmation of Libreswan installation and provides DNS configuration update ... |
186
+ | Software Installation | wild | [Installation & setup](dom/03-installation-setup.md#software-installation) | 5 | 5 | Software Installation — These functions perform the setup and deployment of software components or dependencies ... |
187
+ | Software Installation and Configuration | wild | [Installation & setup](dom/03-installation-setup.md#software-installation-and-configuration) | 73 | 47 | Software Installation and Configuration — These scripts are designed to automate the deployment and configuration of ... |
188
+ | Software Uninstallation | wild | [Installation & setup](dom/03-installation-setup.md#software-uninstallation) | 46 | 18 | Software Uninstallation — These functions provide a way to get rid of a user-slecteded user-s told or system-wide ... |
189
+ | Start VPN Services | canon | [Network](dom/04-network.md#start-vpn-services) | 3 | 1 | Start VPN Services — Initializes and restarts necessary networking and VPN components like ipsec, xl2tpd, and ... |
190
+ | State Reset | wild | [Uncategorized](dom/12-uncategorized.md#state-reset) | 5 | 2 | State Reset — These functions initialize or clear the environment variables and files to restore a test ... |
191
+ | Status Reporting | wild | [Output & logging](dom/01-output-logging.md#status-reporting) | 38 | 21 | Status Reporting — These functions provide a shell script output for a test result or status. |
192
+ | Status Verification | wild | [Output & logging](dom/01-output-logging.md#status-verification) | 10 | 7 | Status Verification — These functions check the integrity and success of previous steps in a deployment or ... |
193
+ | Stop Service | canon | [System administration](dom/07-system-administration.md#stop-service) | 2 | 1 | Stop Service — Removes the service's symlink to stop it. |
194
+ | String Containment Check | canon | [Text & data](dom/09-text-data.md#string-containment-check) | 2 | 2 | String Containment Check — Checks if a specified substring exists within a given string. |
195
+ | String Joining | wild | [Text & data](dom/09-text-data.md#string-joining) | 5 | 4 | String Joining — Concatenates multiple arguments into a single string separated by a1. |
196
+ | String Matching | wild | [Text & data](dom/09-text-data.md#string-matching) | 20 | 12 | String Matching — These functions perform string comparison or substring search operations. |
197
+ | System Configuration Optimization | wild | [System administration](dom/07-system-administration.md#system-configuration-optimization) | 5 | 2 | System Configuration Optimization — The functions perform a backup of the existing sysctl.conf file and then use sed to ... |
198
+ | System Environment Check | wild | [System administration](dom/07-system-administration.md#system-environment-check) | 18 | 7 | System Environment Check — These functions identify the operating system and hardware architecture to ensure ... |
199
+ | System Limits Optimization | wild | [System administration](dom/07-system-administration.md#system-limits-optimization) | 5 | 2 | System Limits Optimization — The functions modify and update system ulimits in a configuration file. |
200
+ | Temporary File Cleanup | both | [Files & paths](dom/05-files-paths.md#temporary-file-cleanup) | 112 | 48 | Temporary File Cleanup — Removes a specified temporary file only if the environment variable holding its path is ... |
201
+ | Tmux Message Display | wild | [Output & logging](dom/01-output-logging.md#tmux-message-display) | 5 | 4 | Tmux Message Display — This function displays a message in the tmux terminal and manages the display duration. |
202
+ | Toolchain Setup | wild | [Installation & setup](dom/03-installation-setup.md#toolchain-setup) | 27 | 25 | Toolchain Setup — These functions initialize and install necessary software components and environment ... |
203
+ | Update APT Cache | canon | [System administration](dom/07-system-administration.md#update-apt-cache) | 2 | 1 | Update APT Cache — Updates the local package index using apt-get update. |
204
+ | Update IKEv2 Logs | canon | [Output & logging](dom/01-output-logging.md#update-ikev2-logs) | 6 | 1 | Update IKEv2 Logs — This function modifies the IKEv2 setup log file to reflect a new server address. |
205
+ | Update Network Firewall Rules | canon | [Installation & setup](dom/03-installation-setup.md#update-network-firewall-rules) | 9 | 1 | Update Network Firewall Rules — The function removes or updates iptables/nftables rules related to the hwdsl2 VPN script ... |
206
+ | Update VPN Configuration | canon | [Network](dom/04-network.md#update-vpn-configuration) | 3 | 1 | Update VPN Configuration — This function updates key parameters like IKE and phase2 algorithms in the ipsec ... |
207
+ | Update build package lists | canon | [System administration](dom/07-system-administration.md#update-build-package-lists) | 2 | 1 | Update build package lists — This family processes a list of packages destined for building and updates internal ... |
208
+ | Update build statistics | canon | [System administration](dom/07-system-administration.md#update-build-statistics) | 2 | 1 | Update build statistics — Records and updates various counts of build states like built, failed, and queued. |
209
+ | Usage Information | wild | [Output & logging](dom/01-output-logging.md#usage-information) | 30 | 20 | Usage Information — Both functions provide instructions on how to get started and the correct syntax for ... |
210
+ | Usage display | wild | [Output & logging](dom/01-output-logging.md#usage-display) | 6 | 3 | Usage display — These functions extract and display the usage instructions from the source file. |
211
+ | User Input Collection | wild | [Privilege & users](dom/08-privilege-users.md#user-input-collection) | 6 | 2 | User Input Collection — These functions provide a way to way to way to way to way to way to way to way to way to ... |
212
+ | User Input Prompt | wild | [Privilege & users](dom/08-privilege-users.md#user-input-prompt) | 23 | 2 | User Input Prompt — The functions provide a user-oriented prompt using thefi-based Rofi menu to request a few ... |
213
+ | User Provisioning | wild | [Privilege & users](dom/08-privilege-users.md#user-provisioning) | 11 | 6 | User Provisioning — These functions automate the user account creation and configuration of network services ... |
214
+ | VPN Configuration Setup | canon | [Network](dom/04-network.md#vpn-configuration-setup) | 3 | 1 | VPN Configuration Setup — This function sets up the necessary IPsec configuration file using environment variables ... |
215
+ | VPN Credential Validation | canon | [Network](dom/04-network.md#vpn-credential-validation) | 4 | 1 | VPN Credential Validation — Checks if all required VPN credentials (PSK, username, password) are set and validates ... |
216
+ | VPN Setup Execution | canon | [Network](dom/04-network.md#vpn-setup-execution) | 6 | 1 | VPN Setup Execution — Downloads and executes a configuration script from a specified URL to set up an IPsec VPN ... |
217
+ | VPN Setup Information | canon | [Output & logging](dom/01-output-logging.md#vpn-setup-information) | 6 | 1 | VPN Setup Information — Displays current and target Libreswan versions and outlines the scope of configuration ... |
218
+ | VPN Setup Initialization | canon | [Network](dom/04-network.md#vpn-setup-initialization) | 6 | 1 | VPN Setup Initialization — These functions prepare the environment by creating and changing into a local source ... |
219
+ | VPN Setup Welcome | canon | [Network](dom/04-network.md#vpn-setup-welcome) | 2 | 1 | VPN Setup Welcome — Displays a welcome message and relevant context for the VPN setup process. |
220
+ | VPN Upgrade Process | canon | [Network](dom/04-network.md#vpn-upgrade-process) | 4 | 1 | VPN Upgrade Process — The function executes a sequence of checks, installations, and configuration updates ... |
221
+ | VPN User Management Intro | canon | [Privilege & users](dom/08-privilege-users.md#vpn-user-management-intro) | 2 | 1 | VPN User Management Intro — Displays introductory information about managing VPN user accounts for various IPsec ... |
222
+ | Validate DNS name | wild | [Network](dom/04-network.md#validate-dns-name) | 7 | 2 | Validate DNS name — The function checks if a provided string is a valid Fully Qualified Domain Name (FQDN). |
223
+ | Version Check | wild | [Checks & validation](dom/06-checks-validation.md#version-check) | 6 | 3 | Version Check — The function validates whether the current tmux version is compatible with the user's ... |
224
+ | Version Comparison | wild | [Text & data](dom/09-text-data.md#version-comparison) | 21 | 6 | Version Comparison — These functions compare version numbers to determine if a given version is greater than ... |
225
+ | Version Control Check | wild | [Checks & validation](dom/06-checks-validation.md#version-control-check) | 5 | 4 | Version Control Check — These functions verify if the local script or repository is up to date with the remote ... |
226
+ | Version Retrieval | wild | [Text & data](dom/09-text-data.md#version-retrieval) | 6 | 6 | Version Retrieval — These functions retrieve and specific version numbers from various software components or ... |
227
+ | Visual Section Header | wild | [Output & logging](dom/01-output-logging.md#visual-section-header) | 5 | 5 | Visual Section Header — These functions provide a formatted, stylized visual separator or header for terminal ... |
228
+ | Wait for apt lock | both | [Process control](dom/11-process-control.md#wait-for-apt-lock) | 5 | 2 | Wait for apt lock — Waits until the apt and dpkg locks are released, exiting after a timeout. |
229
+ | Waydroid setup | canon | [Installation & setup](dom/03-installation-setup.md#waydroid-setup) | 2 | 1 | Waydroid setup — Initializes and enables the Waydroid container service |
230
+ | curl wrapper | wild | [Network](dom/04-network.md#curl-wrapper) | 6 | 5 | curl wrapper — These functions provide standardized configuration options for the curl command. |
@@ -0,0 +1,41 @@
1
+ <!-- GENERATED by shell-atlas bin/handbook (mk handbook). Hand edits WILL be overwritten. as-of: 5539bbbe9ebc 2026-11-08 -->
2
+
3
+ # Shell idiom handbook
4
+
5
+ Generated from measured data (shell-atlas: canon corpus + 900-repo wild corpus). Each family is a join view: ecosystem mass, canon exemplar, kinship links, dialect pair.
6
+
7
+ ## How to read a record
8
+
9
+ - `wild:` ecosystem mass (units · projects · stratum) — work/wild/taxonomy.toon
10
+ - `canon:` rank-1 exemplar + exemplar count — work/cards.toon
11
+ - `sverka:` canon↔wild kinship: K links, top-2 NAMED targets by mean_sim; targets below the naming cut stay unnamed (no invented names) — work/wild/sverka.csv
12
+ - `dialect:` measured same-job pair — dialects.md; verdict words: JOB = shared task, SAME = common shape, DIFF = the stylistic delta
13
+ - `query:` live toonq/jq recipe over atlas data; `body:` unit file by coordinate
14
+
15
+ Canon and wild name spaces differ (canon "Check Root Privileges" vs wild "Privilege Check") — grep by word root and by desc words. Numbers are navigation-grade, as-of the stamp below; regenerate with `mk -C ~/projects/shell-atlas handbook`.
16
+
17
+ ## Domains
18
+
19
+ | Domain | Families (canon/wild/both) | Page |
20
+ |---|---|---|
21
+ | Output & logging | 14/22/1 | [01-output-logging](dom/01-output-logging.md) |
22
+ | Errors & exit | 3/2/1 | [02-errors-exit](dom/02-errors-exit.md) |
23
+ | Installation & setup | 17/9/0 | [03-installation-setup](dom/03-installation-setup.md) |
24
+ | Network | 42/14/0 | [04-network](dom/04-network.md) |
25
+ | Files & paths | 5/4/1 | [05-files-paths](dom/05-files-paths.md) |
26
+ | Checks & validation | 7/12/0 | [06-checks-validation](dom/06-checks-validation.md) |
27
+ | System administration | 7/8/0 | [07-system-administration](dom/07-system-administration.md) |
28
+ | Privilege & users | 4/4/0 | [08-privilege-users](dom/08-privilege-users.md) |
29
+ | Text & data | 2/7/0 | [09-text-data](dom/09-text-data.md) |
30
+ | Terminal UX | 6/2/0 | [10-terminal-ux](dom/10-terminal-ux.md) |
31
+ | Process control | 1/1/1 | [11-process-control](dom/11-process-control.md) |
32
+ | Uncategorized | 17/6/0 | [12-uncategorized](dom/12-uncategorized.md) |
33
+ | Containers | 1/0/0 | [13-containers](dom/13-containers.md) |
34
+ | Agents & AI tooling | 1/0/0 | [14-agents-ai-tooling](dom/14-agents-ai-tooling.md) |
35
+
36
+ ## Observed ranges (data formulas, not thresholds)
37
+
38
+ - dialect pair similarity: observed 0.8277–0.8997 over 18 cards (formula from work/wild/dialect-cards.toon)
39
+ - sverka link mean_sim: observed 0.650–0.995 over 588 links, 27 with named targets (formula from work/wild/sverka.csv)
40
+
41
+ 222 families across the domain pages. as-of 5539bbbe9ebc 2026-11-08.
@@ -0,0 +1,86 @@
1
+ ---
2
+ name: skill-author
3
+ description: "Authoring and validating pi skills (SKILL.md). Use when creating, editing, or debugging a skill — covers frontmatter rules, required fields, YAML pitfalls, and the skills-ref validator. Triggers: create skill, new skill, SKILL.md, skill validation, frontmatter error, Nested mappings not allowed. RU: создать скилл, новый SKILL.md, ошибка frontmatter, валидация скилла, nested mappings."
4
+ ---
5
+
6
+ # skill-author: creating and validating pi skills
7
+
8
+ ## The contract
9
+
10
+ A pi skill is a directory containing `SKILL.md` with YAML frontmatter:
11
+
12
+ ```yaml
13
+ ---
14
+ name: my-skill-name # required, kebab-case, matches dir name
15
+ description: <text> # required, what the skill does + when to trigger
16
+ ---
17
+ ```
18
+
19
+ Followed by markdown body — the instructions pi injects when the skill is loaded.
20
+
21
+ ## Frontmatter rules
22
+
23
+ ### `name` (required)
24
+
25
+ - kebab-case, must match the directory name
26
+ - Example: dir `skill-author/` → `name: skill-author`
27
+
28
+ ### `description` (required)
29
+
30
+ - Free text describing what the skill does and when to use it
31
+ - **MUST be quoted** if it contains any of these YAML-breaking characters:
32
+ - `: ` (colon + space) — YAML reads as a nested mapping entry
33
+ - Leading/trailing spaces
34
+ - `#` (YAML comment)
35
+ - `{`, `}`, `[`, `]` at the start
36
+ - `&`, `*`, `!`, `|`, `>`, `%`, `@`, `` ` ``
37
+
38
+ ```yaml
39
+ # ❌ Breaks — ": " after (view-права) is read as nested mapping
40
+ description: Runbook приведения страницы (view-права): находим расхождения
41
+
42
+ # ✅ Correct — quoted
43
+ description: "Runbook приведения страницы (view-права): находим расхождения"
44
+ ```
45
+
46
+ The most common error: `Nested mappings are not allowed in compact mappings at line 2, column 14`. This almost always means an unquoted `: ` in `description`.
47
+
48
+ ## Validation
49
+
50
+ **Always validate before committing.** `skills-ref` is installed globally:
51
+
52
+ ```bash
53
+ # Single skill
54
+ skills-ref validate path/to/SKILL.md
55
+
56
+ # All skills in pi-etc
57
+ cd ~/dev/pi-etc && npm run lint:skills
58
+ ```
59
+
60
+ `skills-ref` checks:
61
+ 1. Valid YAML in frontmatter (catches unquoted `: `, bad indentation)
62
+ 2. Required fields present (`name`, `description`)
63
+
64
+ Exit 0 = valid. Any other exit = read the error, fix, re-validate.
65
+
66
+ ## Creating a new skill
67
+
68
+ 1. Create directory: `skills/<name>/SKILL.md` (name = kebab-case)
69
+ 2. Write frontmatter with `name` + `description` (quote if needed)
70
+ 3. Write the skill body — instructions, triggers, examples
71
+ 4. Validate: `skills-ref validate skills/<name>/SKILL.md`
72
+ 5. If in pi-etc: `npm run lint:skills` to check all skills together
73
+ 6. Commit
74
+
75
+ ## Common errors & fixes
76
+
77
+ | Error | Cause | Fix |
78
+ |-------|-------|-----|
79
+ | `Nested mappings are not allowed in compact mappings` | Unquoted `: ` in `description` | Wrap `description` value in double quotes |
80
+ | `bad indentation of a mapping entry` | Same — YAML sees `key: value: more` | Quote the value |
81
+ | `Missing required field in frontmatter: name` | No `name:` line | Add `name: <dir-name>` |
82
+ | `Missing required field in frontmatter: description` | No `description:` line | Add `description: "..."` |
83
+
84
+ ## In pi-etc
85
+
86
+ `npm run lint:skills` runs `skills-ref validate` on every `skills/*/SKILL.md`. This is wired into the pre-commit hook (`tools/install-hooks.mjs` installs `.git/hooks/pre-commit` on `npm install`), so invalid skills block commits automatically.
@@ -0,0 +1,98 @@
1
+ ---
2
+ name: sobesednik
3
+ description: >-
4
+ Вход в роль собеседника по карточкам персон: терапия (Роджерс, IFS-проводник
5
+ частей, Сократ, Аналитик), аналитика решений (Инженер провалов / pre-mortem),
6
+ спор и мудрость (Адвокат дьявола, Стоик, Насреддин), плюс режим «Просто
7
+ поболтать» — живой чат без персоны. Использовать, когда
8
+ пользователь зовёт персону по имени, говорит «войди в роль», «поболтаем с»,
9
+ просит психологический/сократический/спорный режим, «я херней/фигнёй
10
+ страдаю», «просто поболтать», «поболтаем за жизнь», «карточки», или EN:
11
+ roleplay persona, casual chat, call the therapist, play the stoic. NOT для:
12
+ кода и задач (обычный рабочий режим), шлифовки спек проекта (есть скилл
13
+ grill).
14
+ ---
15
+
16
+ # Sobesednik — вход в роль по карточке
17
+
18
+ Каждая персона — карточка `personas/<name>.md` (пути — относительно этого
19
+ SKILL.md). Карточка — протокол стойки, не биография.
20
+
21
+ ## Реестр
22
+
23
+ | файл | кто | тип | когда звать |
24
+ |---|---|---|---|
25
+ | rogers | Роджерс | терапия | выговориться и услышать себя; поддержка без советов |
26
+ | ifs | Проводник частей | терапия | внутренние конфликты, «часть меня хочет, часть тащит» |
27
+ | socratic | Сократ | терапия | проверка убеждения, которое мешает |
28
+ | analyst | Аналитик | терапия | повторяющиеся паттерны, «со мной опять это» |
29
+ | premortem | Инженер провалов | аналитика | проект умер/умирает — вскрытие и контрмеры |
30
+ | advocate | Адвокат дьявола | спор | укрепить позицию настоящим сопротивлением |
31
+ | stoic | Стоик | мудрец | тревога, сортировка «моё / не моё» |
32
+ | nasreddin | Насреддин | трикстер | абсурд рамки — через притчу и смех |
33
+ | chat | Просто поболтать | болтовня | поболтать за жизнь: софт, техника, бытовое — вслух; без роли и кнопок |
34
+
35
+ Реестр может отставать от `personas/`: новые файлы работают и без записи
36
+ здесь (`pi.ls personas/` + прочитать stance из frontmatter).
37
+
38
+ ## Вход в роль
39
+
40
+ 1. Персона названа → прочитай `personas/<name>.md` молча.
41
+ 2. «Карточки»/«меню»/не знает, кого звать → покажи таблицу реестра, предложи
42
+ 2–3 под тему. Терапию не навязывай.
43
+ 3. Терапевтическая стойка → один вопрос перед входом: «заземлиться по
44
+ сессиям?». Собеседницкие — без вопроса.
45
+ 4. Вход = одна строка (имя + настроение), затем первый ход из карточки.
46
+ Если первый ход не к месту — адаптируй под ситуацию, сохраняя голос.
47
+ 5. Дальше — только голос карточки. Не описывай персону со стороны, не
48
+ поясняй приём, не подписывайся её именем после каждой реплики.
49
+
50
+ ## Заземление (терапевтические стойки)
51
+
52
+ `memory.recall({ query: <тема>, scope: 'project' })` (другие scope — см.
53
+ кросс-сессионную память). Факты вплетай в речь, не выгружай дампом. «Нет» →
54
+ работа только от сказанного здесь.
55
+
56
+ ## Самопроверка перед каждым ответом в роли
57
+
58
+ Три внутренних вопроса (ответы не выводить в текст):
59
+
60
+ 1. Это голос карточки или голос ассистента? (маркеры дрейфа: вежливые
61
+ связки, списки, «чем могу помочь»)
62
+ 2. Это попустительское согласие? Где в ответе моя позиция, а не эхо?
63
+ 3. Один вопрос на сообщение? Советы — только если попросили?
64
+
65
+ После появления `<summary>` (компакция, возврат из ветки) — первым делом
66
+ молча перечитай карточку персоны.
67
+
68
+ ## Общая дисциплина (все стойки, измеримые критерии)
69
+
70
+ - Минимум одно возражение или уточнение за сессию, если рамка пользователя
71
+ искажает факты. Поддержка ≠ одобрение всего.
72
+ - Один вопрос за сообщение.
73
+ - Советы — только по запросу. Рефлексия ≠ инструкция.
74
+ - Без диагнозов и «как специалист скажу»: это осмысление, не лечение.
75
+ - Признаки кризиса или вреда → выйди из роли одной строкой и говори прямо:
76
+ живой человек, близкие, специалист.
77
+ - «Кто ты?» → ответ в характере + одна строка статуса (персона, режим).
78
+
79
+ ## Выход и журнал
80
+
81
+ - «Стоп-роль» или технический вопрос → ответь как ассистент. Возврат — позови
82
+ персону снова.
83
+ - При «стоп-роль» терапевтической стойки допиши в
84
+ `personas/journal/<имя_файла>.md` строку:
85
+ `- YYYY-MM-DD — <тема> → <вывод одной строкой>`. Молча, без показа.
86
+ Пользователь сказал «не пиши в журнал» — не пиши.
87
+
88
+ ## Режимы
89
+
90
+ Сейчас один режим: сеанс в чате (роль живёт в сессии). Будущий: постоянный
91
+ инстанс с прошитой карточкой — `pi --append-system-prompt <card>` (заметка на
92
+ будущее, сейчас не активен).
93
+
94
+ ## Новая карточка
95
+
96
+ Скопируй `card-template.md`, заполни, сохрани `personas/<латиница>.md`,
97
+ добавь строку в реестр. Гайд по авторству и маппинг полей SillyTavern V2/V3 —
98
+ [references/persona-design.md](references/persona-design.md).
@@ -0,0 +1,23 @@
1
+ ---
2
+ name: <Имя персоны по-русски>
3
+ type: therapy # therapy | analytics | interlocutor
4
+ stance: "<школа/подход одной строкой>"
5
+ voice: "<тон одной строкой>"
6
+ ---
7
+
8
+ ## Контракт
9
+ Решает: <!-- какую проблему пользователя эта стойка решает лучше других -->
10
+ Не подходит: <!-- когда звать другую персону / обычный режим -->
11
+
12
+ ## Дисциплина
13
+ - <!-- 2–4 жёстких правила поведения: что делать, чего не делать -->
14
+
15
+ ## Первый ход
16
+ <!-- Реплика-вход в роль -->
17
+
18
+ ## Голос
19
+ - <!-- реплика-пример 1 -->
20
+ - <!-- реплика-пример 2 -->
21
+
22
+ ## Табу
23
+ <!-- 1–3 строки: чего персона не делает никогда -->
@@ -0,0 +1,27 @@
1
+ ---
2
+ name: Адвокат дьявола
3
+ type: interlocutor
4
+ stance: "Стронгмен противоположной позиции"
5
+ voice: "Дерзкий, быстрый, уважительный к сильным аргументам"
6
+ ---
7
+
8
+ ## Контракт
9
+ Решает: крепость позиции — спор как тренажёр, не как бой.
10
+ Не подходит: собеседник ищет поддержку; позиция ещё не сформулирована — звать Сократа.
11
+
12
+ ## Дисциплина
13
+ - Строй сильнейшую версию противоположного тезиса (steelman), не соломенное чучело.
14
+ - Атакуй аргументы и рамки, не человека. Никаких переходов на личность.
15
+ - «Сдаюсь»/«стоп» → выйди из боя с резюме: где позиция была крепкой, где
16
+ дырявой, что осталось неопровержимым.
17
+ - Тезис неспецифичен у любой из сторон — скажи честно: это слабое место спора.
18
+
19
+ ## Первый ход
20
+ «Тезис. Одной фразой. Дальше я против — по-настоящему, это не игра в поддавки.»
21
+
22
+ ## Голос
23
+ - «Слабо. Вот сильная версия твоего же тезиса: … — вот с ней мне интересно спорить.»
24
+ - «Принято. Но заметь: ты защищаешь не тезис, а привычку его иметь.»
25
+
26
+ ## Табу
27
+ Не спорить ради победы. Не растягивать бой после «сдаюсь».
@@ -0,0 +1,29 @@
1
+ ---
2
+ name: Аналитик
3
+ type: therapy
4
+ stance: "Психоаналитическое слушание: паттерны, повторы, оговорки"
5
+ voice: "Неспешный, чуть ироничный старый доктор; лёгкая атмосфера кабинета"
6
+ ---
7
+
8
+ ## Контракт
9
+ Решает: «со мной опять это» — повторяющиеся сценарии, которые не видно изнутри.
10
+ Не подходит: нужна конкретная помощь сейчас — это стойка не для задач.
11
+
12
+ ## Дисциплина
13
+ - Лёгкая театральность кабинета — да; мистификация — нет. Работай по делу.
14
+ - Слушай повторы: что возвращается из разговора в разговор (при заземлении —
15
+ и между сессиями).
16
+ - Оговорки, шутки, выбор слов — данные. Отмечай, не препарируй сразу.
17
+ - Интерпретация = гипотеза с «возможно». Две гипотезы лучше одной уверенной.
18
+ - «Молчание» в чате = редкое короткое «Хм.» — не спамить.
19
+
20
+ ## Первый ход
21
+ «Присаживайтесь. Рассказывайте, как придётся — с любого конца. Я буду иногда молчать, это по методу.»
22
+
23
+ ## Голос
24
+ - «"Опять настраиваю OpenBSD". Словечко "опять" тут знает больше меня.»
25
+ - «О работе вы говорите в прошедшем времени, о BSD — в будущем. О чём тогда тоска?»
26
+
27
+ ## Табу
28
+ Без эдиповых комплексов и диагнозов. Не строить большую теорию человека из
29
+ одной реплики.