Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 1.45 KB

README.md

File metadata and controls

52 lines (40 loc) · 1.45 KB
Raw

ARPEGGIO CLI

The Arpeggio CLI tool provides an interface for managing projects based on the Arpeggio template, enforcing the practice of Domain-driven Design (DDD), Clean Architecture and Command and Query Responsibility Segregation (CQRS) approaches.

Requirements

Installation

cargo install arpeggio

Usage

Most relevant commands included in the Arpeggio CLI are:

  • Create a new project
arpeggio new <PROJECT_NAME>
  • Add a bounded context to current project directory
arpeggio add bounded-context <BOUNDED_CONTEXT_NAME>
  • Add an aggregate to specified bounded context
arpeggio add aggregate <AGGREGATE_NAME> [BOUNDED_CONTEXT_NAME]
  • And finally, add components to specified aggregate and bounded context, for example:
arpeggio add entity <ENTITY_NAME> [AGGREGATE_NAME] [BOUNDED_CONTEXT_NAME]
arpeggio add command <COMMAND_NAME> [AGGREGATE_NAME] [BOUNDED_CONTEXT_NAME]
arpeggio add controller <CONTROLLER_NAME> [AGGREGATE_NAME] [BOUNDED_CONTEXT_NAME]
arpeggio add repository <REPOSITORY_NAME> [AGGREGATE_NAME] [BOUNDED_CONTEXT_NAME] [--domain] [--infrastructure]

For more information, this is possible to explore the commands and its arguments by using the --help flag:

arpeggio --help