turbo_promptable library
Object-Oriented Prompting framework for defining AI agent prompts, roles, workflows, and tools as type-safe Dart objects.
Classes
- Ability
- A discrete capability that a system provides, linked to features and modules.
- Actor
- Api
- Checklist
- A named list of string items used for acceptance criteria, constraints, etc.
- Cli
- Collection
- Concept
- Context
- Convention
- Decision
- Documentation
- EndGoal
- Event
- Feature
- A user-facing feature scoped to one or more projects.
- HeadlessInvocation
- Fully-composed non-interactive CLI invocation for a TCliTool.
- Input
-
The request side of a Step or
Activity: a proserequestdescribing exactly what the step receives, plus optional structured context. - Insight
- Instruction
- Behavioural guidance containing principles, rules, mindset, and examples.
- InteractiveInvocation
- Fully-composed interactive CLI invocation for a TCliTool.
- Issue
- Meeting
- Memory
- Mockup
- A visual mockup linked to abilities, features, modules, journeys, scenarios, issues, and PRDs.
- Module
- A logical module that groups related functionality within a project.
- OfAbilities
- OfFeatures
- OfIssues
- OfJourneys
- OfMockups
- OfModules
- OfPrds
- OfProjects
- OfPrototypes
- OfScenarios
- Output
- Persona
- Progress
- Prototype
- An interactive prototype linked to features, modules, abilities, journeys, scenarios, issues, PRDs, and mockups.
- Reference
- Requirement
- Base class for requirements that reference abilities, journeys, and scenarios.
- Role
- Script
- Skill
- Spec
- Stakeholder
- Step
- Subject
- SystemPromptArgv
- Tool accepts the system prompt via a CLI flag. The enum value has already resolved which content to embed (inline rendered text or the rendered file path) and returns the complete argv fragment.
- SystemPromptConfigFile
- Tool configures the system prompt via a config file written to disk. The consumer writes configContents to configPath before launch, then extends the process argv with argv.
- SystemPromptInvocation
- Describes how a given TCliTool accepts a system prompt for a non-interactive launch.
- SystemPromptUnsupported
- Tool has no documented non-interactive system-prompt mechanism.
- Task
- A unit of work derived from issues, PRDs, mockups, and prototypes.
- Template
- TFile
- A file to be spawned from a TPromptable, with an optional custom fileName.
- TFolder
- A directory containing TFile entries to be spawned on disk.
- TFR
- A functional requirement linked to abilities, journeys, and scenarios.
- TJourney
- An end-to-end user journey through the system.
- TMetaData
- Structured metadata attached to any TPromptable.
- TNFR
- A non-functional requirement linked to abilities, journeys, and scenarios.
- Tool
- ToolAbility
- A reusable description of any tool-shaped thing: CLI tools, REST/GraphQL APIs, MCP servers, SDK libraries, browser automation, and so on.
- TPromptable
- TScenario
- A usage scenario that exercises one or more abilities within a journey.
- Workflow
- An ordered sequence of Steps that define a process.
Extensions
Typedefs
- TFrontMatter = TMetaData
- Alias for TMetaData, used when the metadata serves as YAML frontmatter.