Skip to main content

Kapitol CLI ("kap")

Kap CLI is designed to simplify and accelerate the development process within our team by providing an interactive command line interface. This tool allows developers to quickly access and execute commands related to different domains, apps, services, and utilities, significantly reducing the complexity and time taken to run common tasks.

Features​

  • Interactive List: Running the kap command triggers an interactive list, offering a user-friendly way to navigate and execute commands.
  • Command Shortcuts: Quick access to frequently used commands through shortcuts, making the development workflow faster and more efficient.
  • Domain Navigation: Easily traverse through different domains such as finesmith, general, kapitol, and utils, and run domain-specific commands.
  • Comprehensive Utility Commands: Access utility commands for tasks such as building, formatting, installing dependencies, and linting across the monorepo.

Getting Started​

Running Kap CLI​

Simply type kap in your terminal to start the interactive list. Use the arrow keys to navigate through the options, which are categorized into shortcuts, domain-specific commands, and utility commands.

Example Interaction​

kap

This command will display the following interactive list:

? What would you like to run? (Use arrow keys)
❯ [Shortcut] kap docs dev          - [docs] Run the Internal Docs site in watch-mode
  [Shortcut] kap finesmith dev     - [web] Run the Finesmith web app in watch-mode
  [Shortcut] kap finesmith service - [service] Run the Finesmith service in watch-mode
  ...additional options...

Selecting a category or a specific command will either execute the command or reveal further actions you can perform.

Advanced Usage​

You can also run a full command path directly, bypassing the interactive list for quicker access. For example:

kap general docs dev

This command is equivalent to navigating through the interactive list to the docs dev script in the general domain but is much faster for experienced users.

Managing the CLI​

For information on adding, removing, or modifying commands and shortcuts in the Kap CLI, please refer to our CLI Management Guide (coming soon)

Conclusion​

The Kap CLI tool is a powerful ally in our development workflow, offering a streamlined approach to accessing and managing the multitude of commands we use daily. By integrating Kap CLI into your routine, you can significantly reduce the time and effort required to perform routine tasks, allowing you to focus more on development.