|

VAPA Help & System Command Group (~h)

Help & System Command Group (~h): Dynamic Assistance and Guidance

The ~h command group is VAPA’s interactive support system and diagnostic hub. It provides context-sensitive help, syntax explanations, and real-time coaching to ensure you can navigate the full VAPA ecosystem with confidence. Whether you are a beginner learning the basics or an advanced user fine-tuning complex workflows, the Help group ensures you have the information needed to maintain total control.

Purpose

To provide on-demand, adaptive assistance that clarifies command syntax, surfaces hidden capabilities, and optimizes the interaction between the user and the VAPA CORE.

Key Capabilities

  • Command Documentation: Detailed explanations of every command family (~a, ~v, ~s, ~f, ~r, ~c, ~x).
  • Syntax & Parsing Diagnostics: Real-time feedback on command errors or formatting issues.
  • Contextual Suggestions: Proactive guidance based on your current session state and active project.
  • Usage Examples: Practical “Quick Start” templates and best practices for every module.
  • System Status: High-level visibility into the active VAPA environment, versioning, and slot stack.

~h Command Structure

The Help system is designed to be lightweight and non-intrusive. Most help commands are one-shot (once) and do not alter your session settings.

CommandNameRoleExample
~h or ~?Master HelpDisplays the main help menu and command family index.~h
~h [cmd]Command HelpProvides detailed syntax and examples for a specific command.~h ~f
~vsVAPA StatusShows the current runtime status, active slots, and settings.~vs
~guideGuide ToggleToggles proactive, contextual suggestions (Sticky).~guide on
~envEnv ReportDisplays host capabilities (Files, Web, Code, etc.).~env

Canonical Tokens & Syntax Reference

VAPA uses a precise token system to separate control instructions from user data. Understanding these tokens is essential for advanced automation and multi-command workflows.

1. Command Structure

  • Prefix (~): Every VAPA command begins with a tilde.
  • Form: ~(group)(sub-command) [options] (e.g., ~fv 3).
  • Stacking (&): Combine multiple commands in a single line.
    • Example: ~fv 1 & ~fs bullets (Set verbosity to 1 AND style to bullets).

2. Message Boundaries

  • Command/Data Separator (~/): Used at the very beginning of a message to separate a command string from the data it should act upon.
    • Example: ~fv 1 & ~fs bullets ~/ Summarize the following text...

3. Inline Instructions (The “Instruction Sandwich”)

  • Start Delimiter (~~): Marks the beginning of a VAPA instruction embedded inside a block of data.
  • End Delimiter (/~): Marks the end of the instruction, returning the AI to data-processing mode.
    • Example: “The following report is confidential. ~~ ~sp on /~ Please analyze the risk factors…”

Examples of Use

  • Learning a New Group
    ~h ~r
    Result: Displays the full documentation for the Research group, including all sub-commands like ~rd and ~ri.
  • Checking Your Setup
    ~vs
    Result: A snapshot of your current environment, showing which Alter-Ego is loaded and which formatting/security modes are active.
  • Complex Multi-Tasking
    ~fv 1 & ~xmtoc ~/ [Long Document Text]
    Result: VAPA sets verbosity to concise, processes the document, and prepares a Markdown export with a Table of Contents in one pass.

Workflow Integration

  • With Builder (~v)
    Use ~h to verify the required fields for a new Alter-Ego or Assistant slot before saving it.
  • With Security (~s)
    If a command is blocked by a security policy, ~h can explain the policy and suggest a safer alternative.
  • With Environment (~env)
    Before attempting a complex export (~x), use ~env to ensure the current host supports the desired file format.