CLI

AxilJS Decorator CLI Commands

List, search, inspect and check AxilJS semantic decorators from the terminal: axil decorator list, info, search, check, graph and categories.

5 min readUpdated DocumentationEdit this page
On this page11

The AxilJS CLI provides a dedicated decorator command group for discovering, inspecting, searching, and analyzing semantic decorators.

The decorator tooling exposes the AxilJS decorator catalog directly from the terminal, allowing developers to explore decorator capabilities and semantic relationships without manually inspecting framework source code.

Start the decorator command group with:

Terminal
❯axil decorator

Without a subcommand it prints the subcommand list. The catalog is bundled in the CLI, so every subcommand works even when @axiljs/decorator is not installed in the current project.

List Decorators

List all decorators available in the AxilJS decorator catalog:

Terminal
❯axil decorator list

The catalog organizes decorators by semantic category and provides metadata describing their intended usage and behavior.

This is useful when you want to discover available decorators before implementing a feature.

Filter Decorators by Category

Use --category to filter the decorator catalog:

Terminal
❯axil decorator list --category <category>

For example, list security-related decorators:

Terminal
❯axil decorator list --category Security

You can also explore other categories:

Terminal
❯axil decorator list --category HTTP
Terminal
❯axil decorator list --category AI
Terminal
❯axil decorator list --category Validation
Terminal
❯axil decorator list --category Observability

Category filtering makes it easier to discover decorators relevant to a particular application concern.

Available Decorator Categories

The AxilJS decorator catalog covers multiple areas of application development:

  • HTTP
  • Security
  • Data
  • Reliability
  • Concurrency
  • Distributed
  • Messaging
  • Caching
  • Observability
  • Compliance
  • Runtime
  • AI
  • Validation
  • Contract
  • Execution
  • Workflow
  • Policy

Use the categories command to display the available categories and their decorator counts:

Terminal
❯axil decorator categories

Inspect Decorator Information

Use info to inspect the semantic metadata for an individual decorator:

Terminal
❯axil decorator info <name>

For example:

Terminal
❯axil decorator info tAuth

You can inspect other decorators in the same way:

Terminal
❯axil decorator info tRateLimit

The info command exposes the decorator's semantic metadata, including:

  • Description
  • Purpose
  • Why to use it
  • When to use it
  • When not to use it
  • Category
  • Supported targets
  • Options
  • Runtime behavior
  • Metadata produced
  • Metadata consumed
  • Composition relationships
  • Conflicts
  • Security impact
  • Performance impact
  • Examples

This makes info useful when you need to understand not only what a decorator does, but also how it interacts with other parts of the AxilJS runtime.

Search the Decorator Catalog

Use search to find decorators using a text query:

Terminal
❯axil decorator search <query>

For example:

Terminal
❯axil decorator search authentication

Other useful searches include:

Terminal
❯axil decorator search cache
Terminal
❯axil decorator search database
Terminal
❯axil decorator search retry
Terminal
❯axil decorator search authorization

The search operation can search across decorator names, descriptions, purposes, categories, and related metadata.

This makes it useful when you know what capability you need but do not know the exact decorator name.

Check Decorator Composition

Use check to inspect decorators used in a source file:

Terminal
❯axil decorator check <file>

For example:

Terminal
❯axil decorator check src/controllers/user.controller.ts

The command identifies decorator composition issues and conflicts based on the semantic relationships defined in the decorator catalog.

This is particularly useful when a declaration contains multiple decorators whose behavior or metadata may interact.

A typical workflow is:

Source File
axil decorator check
Read Decorator Metadata
CompositionConflicts

Generate a Metadata Graph

Use graph to print the metadata graph of the whole decorator catalog as JSON:

Terminal
❯axil decorator graph

graph takes no file argument. It always emits the full catalog, and its output is pure JSON on stdout (no title, no colour), so you can pipe it into other tools:

Terminal
❯axil decorator graph > decorator-graph.json

Each entry lists a decorator's relationships:

JSON
JSON
1{
2  "decorators": [
3    {
4      "name": "tRetry",
5      "category": "Reliability",
6      "consumedBy": ["..."],
7      "composesWith": ["..."],
8      "conflictsWith": ["..."]
9    }
10  ]
11}

Use it to see which runtime consumes a decorator's metadata and which decorators compose with, or conflict with, each other. To check the decorators in one source file, use axil decorator check <file> instead.

Categories Command

The categories command displays the available decorator categories:

Terminal
❯axil decorator categories

The output provides a high-level view of the decorator catalog and the number of decorators available in each category.

Use this command when exploring the overall scope of the AxilJS semantic decorator system.

When working with an unfamiliar decorator, start by searching the catalog:

Terminal
❯axil decorator search authentication

Inspect a relevant decorator:

Terminal
❯axil decorator info tAuth

To explore all decorators within a category:

Terminal
❯axil decorator list --category Security

After applying decorators to a source file, check their composition:

Terminal
❯axil decorator check src/controllers/user.controller.ts

You can then export the catalog's metadata relationships as JSON:

Terminal
❯axil decorator graph

The workflow can be summarized as:

Search
Discover Decorator
Inspect Metadata
Apply Decorator
Check Composition
Analyze Metadata Graph

Command Reference

CommandDescription
axil decorator listList decorators
axil decorator list --category <category>Filter decorators by category
axil decorator info <name>Show decorator metadata
axil decorator search <query>Search the decorator catalog
axil decorator check <file>Check decorator composition and conflicts
axil decorator graphPrint the catalog metadata graph as JSON
axil decorator categoriesList decorator categories

Semantic Decorator Tooling

The AxilJS decorator CLI makes the framework's semantic decorator system available directly from the terminal.

Instead of manually searching framework source code, developers can use the CLI to discover decorators, inspect their semantic metadata, search by capability, check decorator composition, identify conflicts, and export the metadata relationships of the whole catalog.

Was this page helpful?

Help improve the documentation

AxilJS is open source and documentation improvements are welcome.

AxilJS DocumentationMIT License · Built by SyntaxilitY