### ElizaOS Plugin Development Commands Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md This snippet outlines the essential commands for managing the ElizaOS plugin development lifecycle. It includes installing dependencies, building the project, running tests, and starting the development server with watch capabilities. ```bash bun install bun run build bun run test bun run dev ``` -------------------------------- ### Install @elizaos/plugin-admin Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Installs the plugin using the bun package manager. ```bash bun install @elizaos/plugin-admin ``` -------------------------------- ### Example Admin Queries Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Demonstrates example queries that can be made to the agent after admin features have been unlocked, mapping natural language requests to specific admin actions. ```text "Give me a global report for today." → GLOBAL_REPORT "List all users." → LIST_ALL_USERS "List all rooms." → LIST_ALL_ROOMS "Search all messages for 'production outage'." → SEARCH_MESSAGES "Audit user abc123." → USER_AUDIT ``` -------------------------------- ### Unlock Admin Features - Example Phrases Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Provides example phrases to use when interacting with the agent to unlock administrative features by providing the secret key. ```text "Unlock admin features, the key is: super-secret-value" "Enter admin mode, my key is super-secret-value" "I need to unlock admin, password: super-secret-value" ``` -------------------------------- ### Plugin Actions Documentation Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Details the available administrative actions provided by the plugin, including their purpose and basic functionality. ```APIDOC UNLOCK_ADMIN_FEATURES: Description: Unlock admin functionality by providing the correct secret key. Details: - Validates against `ADMIN_PASSWORD` environment variable - Uses SHA-256 hashing for security - Unlocks all other admin actions once validated GLOBAL_REPORT: Description: Generate a summary of all activity across rooms for a specific day. Details: - Shows total message count - Lists activity per room - Defaults to current day, or specify date in format YYYY-MM-DD LIST_ALL_USERS: Description: Returns all entities/users known to the agent. Details: - Shows entity IDs and names - Limited to 20 in chat response (full data in response object) LIST_ALL_ROOMS: Description: Lists all rooms/channels the agent has participated in. Details: - Shows room names and IDs - Includes source platform information SEARCH_MESSAGES: Description: Search for messages containing specific text across all rooms. Details: - Case-insensitive search - Returns up to 10 matching messages with context - Shows timestamp, room, and entity information USER_AUDIT: Description: Generate a detailed audit report for a specific user. Details: - Total message count and date range - Room activity breakdown - Recent message samples - Requires user/entity ID ``` -------------------------------- ### Global Context Provider Functionality Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Explains the data injected by the GLOBAL_CONTEXT provider when admin features are unlocked, enabling holistic LLM responses. ```APIDOC GLOBAL_CONTEXT Provider: Description: Injects global context into the LLM prompt when admin features are unlocked. Injected Data: - Summary of last 50 messages across all rooms - Message counts per room - Formatted for LLM context understanding Example LLM Queries: - "What happened across all chats today?" - "Summarize the key discussions from all rooms" - "Who has been most active today?" ``` -------------------------------- ### Security Considerations Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Outlines key security aspects of the plugin, including password hashing, session-based access, read-only operations, and audit logging. ```APIDOC Security Considerations: 1. Password Hashing: Stores only a SHA-256 hash in memory; plaintext password remains in process.env. 2. Session-based: Admin features are granted per runtime session and require re-authentication upon agent restart. 3. Read-only: Current actions are read queries; write operations require careful permission checks. 4. Audit logs: Recommends emitting events for admin actions to maintain an audit trail. ``` -------------------------------- ### Database Schema Requirements Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Specifies the database tables and structure expected by the plugin for storing messages, entities, and rooms. ```APIDOC Database Schema: The plugin utilizes ElizaOS's standard database interface. Expected Tables: - `memories`: Stores messages. - `entities`: Stores user information. - `rooms`: Stores chat rooms/channels. Note: No custom SQL or schema modifications are required. ``` -------------------------------- ### Add Plugin to Agent Character File Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Configures an ElizaOS agent to use the admin plugin by adding it to the agent's character file. ```json { "name": "MyAgent", "plugins": [ "@elizaos/plugin-bootstrap", "@elizaos/plugin-admin" ] } ``` -------------------------------- ### Set Admin Password Configuration Source: https://github.com/elizaos-plugins/plugin-admin/blob/1.x/README.md Sets the ADMIN_PASSWORD environment variable in a .env file to unlock admin features. ```env ADMIN_PASSWORD=super-secret-value ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.