Skills

A skill is a package of structured files that teaches an AI coding agent how to work with a specific tool or framework. The skill below was generated by Great Docs from this project’s documentation. Install it in your agent and it will be able to run commands, edit configuration, write content, and troubleshoot problems without step-by-step guidance from you.

Any agent — install with npx:

npx skills add https://mjfrigaard.github.io/splam/

Codex / OpenCode

Tell the agent:
Fetch the skill file at https://mjfrigaard.github.io/splam/skill.md and follow the instructions.

Manual — download the skill file:

curl -O https://mjfrigaard.github.io/splam/skill.md

Or browse the SKILL.md file.

SKILL.md

---
name: splam
description: >
  Shiny for Python app for Linux administration. Use when writing Python code that uses the splam package.
compatibility: Requires Python >=3.11.
---

# splam

Shiny for Python app for Linux administration

## Installation

```bash
pip install splam
```

## API overview

### Functions

Utility functions

- `add_highlight_keyword`: Persist a custom keyword/phrase to highlight class mapping
- `add_user`: Add or replace a user's salted password hash and role
- `attempt_login`: Verify credentials subject to failed-attempt lockout
- `build_client`: Return a chatlas client seeded with the admin-task notes for `services`
- `chat_available`: Return True when the optional `chat` extra is installed
- `doc_columns`: Return the man page width in columns that fills `width_px` of screen
- `doc_references`: Return the URIs listed in the unit's `Documentation=` property
- `get_all_service_info`: Return built-in SERVICE_INFO merged with user-saved overrides (overrides win)
- `get_documentation`: Return `systemctl help <service>`: the man pages named by Documentation=
- `get_logs`: Return the last `lines` journalctl entries for `service`, newest first
- `get_role`: Return a user's role, or `DEFAULT_ROLE` for records saved before roles existed
- `get_service_info`: Return admin-task notes for a service, falling back to generic guidance
- `get_status`: Return combined stdout/stderr of `systemctl status <service>`
- `highlight`: Escape `text` and wrap known (and user-added) keywords in colored spans
- `highlight_term`: Escape `text` and wrap case-insensitive matches of `term` in <mark>
- `list_services`: Return sorted service names known to systemd that have admin-task notes
- `load_users`: Load the credentials file, or an empty dict if it doesn't exist yet
- `lockout_remaining`: Return whole seconds left on `username`'s lockout, or 0 if it isn't locked
- `record_action`: Append a timestamped audit entry for a service control action
- `record_auth`: Append a timestamped audit entry for a login or logout attempt
- `read_audit_log`: Return the most recent audit entries, newest first, optionally filtered by service
- `read_only_tools`: Return the read-only functions a chat client may call
- `redact`: Replace anything secret-shaped in a shell command line with `[REDACTED]`
- `save_service_info`: Persist a user-edited admin-task entry for `service`, overriding any built-in entry
- `system_prompt`: Build a system prompt covering every service discussed so far
- `systemctl_action`: Run `systemctl <action> <service>` and return the completed process
- `verify_user`: Check a username/password pair against the stored hash

## Resources

- [Full documentation](https://mjfrigaard.github.io/splam/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs