@autofleet/cli
v2.36.0
Published
Maintainers
Keywords
Readme
AutoFleet CLI
Overview
The AutoFleet CLI is a tool designed to simplify and streamline common development and operational tasks within the AutoFleet ecosystem.
Getting Started
To test the CLI on your local environment, follow these steps:
- Run
pnpm installfrom the monorepo root to install dependencies. - Build the project with
pnpm build cli. - Start the CLI with
pnpm --filter @autofleet/cli start <command>ornpm start <command>from the CLI package directory.
Available Commands
autofleet (autofleet <command>)
| Command | Description |
|----------------------|-----------------------------------------------------------------------------|
| switchCluster | Switches the connected Kubernetes (K8S) cluster. With option to switch to specific simulation |
| exposeService | Exposes a Google Cloud Platform (GCP) service with a public IP via a LoadBalancer. |
| forwardDb | Performs a port forward to the database of an environment and opens it in Postico. |
| forwardService | Port forwards to a microservice (MS) in a specified environment. |
| getIps | Lists the IPs of all microservices (MSs) in a specified environment. |
| enableSimulator | Used to enable the simulator when debugging the Simulation Cluster Variations. |
| rabbitCreds | Retrieves RabbitMQ credentials for a specified environment. |
| updateExp | Updates the image of a simulation, most often from your local repository of the service. |
| localDev | Sets up the .env file in Control Center and port-forwards into control-center-ms for local development. |
| mirrord | Starts a Mirrord session for debugging. |
| mirrordConfig | Configures the Mirrord file for a microservice (MS). |
| dockerInit | Create docker containers for Postgres, Redis and Rabbit locally. |
| openRedis | Open redis cli for a specific redis instance in a specific cluster |
| ~~telepresenceWizard~~ | Used to set up a connection via Telepresence for debugging before Mirrord. This is deprecated. |
git (git autofleet <command>)
| Command | Description | |----------------------|-----------------------------------------------------------------------------| | bumpVersion | Bumps the version, and commits the package and package-lock files. Make sure your git stage is clear, and you have no further changes within these files | | openPR | Open PR for the current branch. | | releaseBeta | Builds the package, bumps the version and releases to a beta tag |
