AIKIT Template Package

A meta-package that provides the aikit.create, aikit.github-actions, and aikit.clarify commands - comprehensive guides for creating new AIKIT template packages, automating their releases, and clarifying template variables.

Overview

This package helps you create your own AIKIT packages by providing:

• Step-by-step instructions for package creation (aikit.create)
• GitHub Actions workflow templates for automated releases (aikit.github-actions)
• Template variable clarification tools (aikit.clarify)
• Best practices and design patterns
• Template examples and common patterns
• Troubleshooting guidance
• Complete workflow from initialization to publishing

Installation

From GitHub

aikit install goaikit/template

Local Development

If you're working on this package locally:

cd template
aikit package build
# Then install the built package

Usage

After installation, use the aikit.create, aikit.github-actions, and aikit.clarify commands in any supported AI agent:

AI Template package Creation (aikit.create)

In Claude Code

aikit.create

In Cursor

aikit.create

In GitHub Copilot

aikit.create

The aikit.create command provides a comprehensive guide that walks you through:

1. Initializing a new package
2. Configuring aikit.toml
3. Creating command templates
4. Building and validating
5. Publishing to GitHub
6. Installation and usage

GitHub Actions Setup (aikit.github-actions)

In Claude Code

aikit.github-actions

In Cursor

aikit.github-actions

The aikit.github-actions command provides:

• Complete GitHub Actions workflow template for automated releases
• Step-by-step setup instructions
• Customization options for different release strategies
• Troubleshooting guidance

Template Variable Clarification (aikit.clarify)

In Claude Code

aikit.clarify

In Cursor

aikit.clarify

The aikit.clarify command provides:

• Automatic scanning of files for bracketed variables (e.g., [VARIABLE_NAME])
• Interactive prompting for variable values
• Batch replacement of all variable occurrences
• Template processing and clarification tools

What You'll Learn

From aikit.create:

• Package Structure: Understanding the required and optional files
• Configuration: How to properly configure aikit.toml
• Template Creation: Best practices for creating command templates
• Command Design: Principles for designing effective commands
• Artifact Mapping: How to organize and install package files
• Validation: Ensuring your package follows AIKIT conventions
• Building: Creating distributable packages
• Publishing: Sharing your package on GitHub
• Testing: Verifying your package works correctly
• Troubleshooting: Common issues and solutions

From aikit.github-actions:

• Automated Releases: Setting up GitHub Actions for package publishing
• Workflow Configuration: Triggers, permissions, and job definitions
• Version Management: Tag-based and manual release strategies
• Release Notes: Auto-generation and customization options
• Multi-platform Builds: Cross-platform package creation
• Integration: Slack, Discord, and other notification options

From aikit.clarify:

• Variable Detection: Identifying bracketed placeholders in templates
• Interactive Prompts: User-friendly value collection
• Batch Processing: Consistent replacement across entire files
• Template Management: Streamlining template customization workflows

Quick Start Example

After installing this package, you can create your own package:

# 1. Initialize a new package
aikit package init my-tools \
  --description "My development tools" \
  --author "Your Name"

# 2. Follow the guide from aikit.create command
# 3. Set up automated releases with aikit.github-actions
# 4. Build your package
cd my-tools
aikit package build

# 5. Publish to GitHub
aikit package publish yourusername/my-tools

Package Information

• Package Name: aikit
• Commands: create, github-actions, clarify
• Version: 1.0.3
• Description: AIKIT package creation guide and template

Commands

This package provides three commands:

• aikit.create: Comprehensive guide for creating new AIKIT packages
• aikit.github-actions: Generate GitHub Actions workflows for automated package releases
• aikit.clarify: Scan and fill template variables interactively

Documentation

For detailed information, see:

• The aikit.create command output (comprehensive package creation guide)
• The aikit.github-actions command output (GitHub Actions workflow guide)
• The aikit.clarify command output (template variable clarification guide)
• AIKIT Template Documentation - Full package creation guide (sibling repo in goaikit checkout)
• AIKIT README - General AIKIT documentation

Examples

Creating a Code Analysis Package

# Use aikit.create command to get the full guide
# Then create your package:
aikit package init code-analysis \
  --description "Code quality analysis tools" \
  --author "Your Name"

# Add commands in aikit.toml:
# [commands.analyze]
# description = "Analyze code quality"
# template = "analyze.md"

# Create templates/analyze.md with your analysis guide
# Set up automated releases with aikit.github-actions
# Build and publish

Creating a Documentation Package

aikit package init doc-generator \
  --description "Generate documentation from code"

# Add documentation generation commands
# Create templates for different doc types
# Set up GitHub Actions workflow for releases
# Build and share

Best Practices

The aikit.create command includes comprehensive best practices for:

• Package naming conventions
• Command design principles
• Template quality standards
• Documentation requirements
• Version management
• Testing strategies

The aikit.github-actions command covers:

• Automated release workflows
• GitHub Actions security best practices
• Release note generation strategies
• Multi-platform build configurations

The aikit.clarify command covers:

• Template variable management
• Interactive prompting best practices
• Batch replacement strategies
• Template maintenance workflows

Contributing

This is a meta-package designed to help others create packages. If you have suggestions for improving the guides:

1. Review the template content in templates/create.md, templates/github-actions.md, and templates/clarify.md
2. Submit improvements via pull request
3. Share your own package examples, GitHub Actions workflows, and template clarification patterns

Related Resources

• AIKIT Repository
• Package Creation Guide
• AIKIT Architecture

License

[Specify license - same as AIKIT project]

Support

For issues or questions:

• Open an issue on the AIKIT GitHub repository
• Reference the aikit.create command for package creation guidance
• Reference the aikit.github-actions command for release automation guidance
• Reference the aikit.clarify command for template variable clarification guidance
• Check the TEMPLATE.MD documentation

---

Note: This package is designed to be a meta-tool - it helps you create other packages. Use the aikit.create command to get started creating your own AIKIT packages, aikit.github-actions to set up automated releases, and aikit.clarify to fill in template variables!