ably-new-command

Scaffold new Ably CLI commands with tests and templates for oclif + TypeScript.

5|Updated Mar 24, 2025
One-click install
npx skills add https://github.com/ably/ably-cli --skill ably-new-command
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ably-new-command
Source: https://github.com/ably/ably-cli/tree/main/.claude/skills/ably-new-command
Command: npx skills add https://github.com/ably/ably-cli --skill ably-new-command

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a guided template and workflow to scaffold new Ably CLI commands, including the command file, test file, and related index/topic files, ensuring consistency with the project's oclif + TypeScript conventions.

Core Features & Use Cases

  • Scaffold command skeletons for new commands, subcommands, migrations, or command scaffolds with tests.
  • Offer templates and patterns for common command types (Subscribe, Publish/Send, History, Get, List, Enter, REST Mutations, CRUD) and guidance on base classes and flags.
  • Integrate with the repository's testing and documentation workflows to accelerate development and maintain consistency.

Quick Start

Create a new Ably CLI command skeleton following this guide and tailor it to your specific command.

Frequently Asked Questions about ably-new-command

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a new oclif command with TypeScript and tests?

You can scaffold a new command by generating a command skeleton alongside its test file, ensuring consistent oclif structure, base classes, flag patterns, and JSON envelopes for the Ably CLI.

What templates are available for creating Ably CLI commands?

Templates cover common command types like Subscribe, Publish/Send, History, Get, List, Enter, and REST Mutations, providing structured scaffolding for consistent command development and testing.

Does this scaffolding tool generate test files automatically?

Yes, the scaffolding process generates both the command file and its corresponding test file, integrating with the repository's testing workflows to accelerate development and maintain consistency.

Can I use this to migrate existing commands to new conventions?

Yes, this skill targets developers creating or migrating commands, enforcing project conventions like base classes, flag patterns, and integrated testing scaffolds for oclif and TypeScript.

What conventions are enforced when generating CLI command skeletons?

The skill enforces oclif and TypeScript conventions, including consistent base classes, flag patterns, JSON envelopes, and integrated testing scaffolds to maintain project structure.