Overview

The nanoservice-ts Command Line Interface (CLI), blokctl, is an essential tool for developing, managing, and deploying your nanoservice-ts applications. It provides a set of commands to streamline common tasks, from project scaffolding to Node and Workflow creation.

What is blokctl?

blokctl is designed to enhance developer productivity by automating repetitive tasks and providing a consistent interface for interacting with the nanoservice-ts framework.

Key functionalities typically include:

• Project Initialization: Creating new nanoservice-ts projects with a standard directory structure and boilerplate code.
• Code Generation (Scaffolding): Generating new Nodes, Workflows, and potentially other components with basic templates.
• Development Server: Running a local development server to test your workflows.
• Building & Packaging: Preparing your application for deployment.
• Deployment Commands: Assisting with deploying your nanoservice-ts applications to various environments (though this might also involve other platform-specific tools).
• Authentication/Login: Commands to authenticate with nanoservice-ts services or platforms (e.g., Deskree).

Installation / Usage

As mentioned in the First Steps guide, you can often use blokctl directly via npx without a global installation, ensuring you always use the latest version:

npx blokctl@latest <command>

Refer to the official nanoservice-ts installation instructions for the recommended approach.

Common Command Categories

This section of the documentation will cover the main commands provided by blokctl, grouped by their purpose:

• Project Management: Commands related to creating and managing nanoservice-ts projects.
  • npx blokctl@latest create project
• Node Management: Commands for scaffolding and managing Nodes.
  • npx blokctl@latest create node
• Workflow Management: Commands for scaffolding and managing Workflows.
  • npx blokctl@latest create workflow
• Authentication: Commands for logging into nanoservice-ts platforms or services.
  • npx blokctl@latest login or npx blokctl@latest logout
• Build Process: Commands related to building your application for production.
  • npx blokctl@latest build
• Deployment: Commands to assist with deploying your application.
  • npx blokctl@latest deploy

Getting Help

Most CLI tools provide a way to get help directly from the command line. You can usually try:

blokctl --help
blokctl <command> --help

This will display a list of available commands or specific options for a given command.

Explore the sub-sections for detailed explanations and examples of each blokctl command group.