GitmoxiLogo Gitmoxi

Navigation Pane

Overview
Getting Started
Install on ECS Fargate
Install on EKS
Repo Setup
Testing ECS
Testing EKS
Testing Lambda
Uninstall Gitmoxi
Core Concepts
Gitmoxi for ECS
ECS Deployment Definition
Gitmoxi for Lambda
Lambda Deployment Definition
Lambda Event Source Mapping
Input Parameterization
CLI Reference

gmctl - Gitmoxi Command Line Interface

gmctl is the command line interface for interacting with Gitmoxi services. It provides various commands for managing repositories, deployments, and commits. Below are global options that apply to all subcommands.

gmctl [OPTIONS] COMMAND [ARGS]...
OptionDefaultDescription
-e, --endpoint-urlenv(GITMOXI_ENDPOINT_URL) or http://127.0.0.1:8080The Gitmoxi FastAPI endpoint URL
-l, --log-levelERRORThe log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)

Repository management commands

Repository-related commands for configuring Git repositories in Gitmoxi.

gmctl repo [SUBCOMMAND]

Add repository

Add repository containing artifacts for Gitmoxi GitOps deployments.

gmctl repo add [OPTIONS]
OptionRequiredDescription
-r, --repo-urlYesThe repository URL
-a, --access-token-arnYesThe access token ARN
-b, --branchesYesBranches in the repository

Example:

gmctl repo add -r https://github_repo -a arn:aws:secretsmanager:us-east-1:12345:secret:my-token -b main -b dev

Get repository

Get repository configuration details such as branch and access token ARN if configured for use with Gitmoxi. If no repository is provided it will list all the configured repositories.

gmctl repo get [OPTIONS]
OptionRequiredDescription
-r, --repo-urlNoThe repository URL

Example:

gmctl repo get

Delete repository

Delete repository configuration for Gitmoxi.

gmctl repo delete [OPTIONS]
OptionRequiredDescription
-r, --repo-urlYesThe repository URL

Example:

gmctl repo delete -r https://github_repo_to_remove

Deployment Management

Commands for managing deployments in Gitmoxi.

gmctl deployment [SUBCOMMAND]

Get Deployments by Commit

Retrieve ECS and Lambda deployment records for a specific commit.

gmctl deployment get [OPTIONS]
OptionRequiredDescription
-c, --commit-hashYesThe commit hash to filter deployments

Example:

gmctl deployment get -c abc123

This command retrieves deployment records for both ECS and Lambda services associated with the specified commit hash. It displays the deployment details in a tabular format for each service.

Output:

  • For ECS deployments, the command displays repository URL, commit hash, account ID, region, service name, cluster, creation timestamp, status, and file prefix.
  • For Lambda deployments, the command displays repository URL, commit hash, account ID, region, function name, creation timestamp, status, and file prefix.

Get ECS Deployments

This command retrieves ECS deployment records based on specified filters. It displays the deployment information in a tabular format and optionally provides detailed status information for each deployment when the verbose flag is enabled.

gmctl deployment ecs get [OPTIONS]
OptionRequiredDescription
-r, --repo-urlNoRepository URL to filter deployments
-c, --commit-hashNoCommit hash to filter deployments
-a, --account-idNoAWS account ID to filter deployments
-re, --regionNoAWS region to filter deployments
-s, --serviceNoECS service name to filter deployments
-cl, --clusterNoECS cluster name to filter deployments
-st, --statusNoDeployment status to filter deployments
Choices: PROCESSING, PROCESSED_ERROR, PROCESSED_SUCCESS
-n, --number-of-recordsNoNumber of records to retrieve (default: 10)
-v, --verboseNoEnable verbose output with detailed status information
-A, --show-allNoShow detailed status for all deployments (not just error states)

The command displays a table with the following fields for each deployment:

  • Repository URL
  • Commit hash
  • AWS account ID
  • AWS region
  • ECS service name
  • ECS cluster name
  • Creation timestamp
  • Deployment status
  • File prefix

When the verbose flag is enabled, additional status details are displayed for deployments in error state. If the show-all flag is also enabled, status details are shown for all deployments regardless of state.

Examples:

  • Basic usage with minimal filters
gmctl deployment ecs get -re us-west-2 -s my-service
  • Filter deployments by repository and status
gmctl deployment ecs get -r https://github.com/example/repo -st PROCESSED_SUCCESS
  • View detailed information for failed deployments
gmctl deployment ecs get -s my-service -v
  • Show detailed information for all deployments
gmctl deployment ecs get -s my-service -v --show-all
  • Limit the number of results
gmctl deployment ecs get -s my-service -n 5

Get Lambda Deployments

This command retrieves Lambda deployment records based on specified filters. It displays the deployment information in a tabular format and optionally provides detailed status information for each deployment when the verbose flag is enabled.

gmctl deployment lambda get [OPTIONS]
OptionRequiredDescription
-r, --repo-urlNoRepository URL to filter deployments
-c, --commit-hashNoCommit hash to filter deployments
-a, --account-idNoAWS account ID to filter deployments
-re, --regionNoAWS region to filter deployments
-fn, --function-nameNoLambda function name to filter deployments
-st, --statusNoDeployment status to filter deployments
Choices: PROCESSING, PROCESSED_ERROR, PROCESSED_SUCCESS
-n, --number-of-recordsNoNumber of records to retrieve (default: 10)
-v, --verboseNoEnable verbose output with detailed status information
-A, --show-allNoShow detailed status for all deployments (not just error states)

The command displays a table with the following fields for each deployment:

  • Repository URL
  • Commit hash
  • AWS account ID
  • AWS region
  • Lambda function name
  • Creation timestamp
  • Deployment status
  • File prefix

When the verbose flag is enabled, additional status details are displayed for deployments in error state. If the show-all flag is also enabled, status details are shown for all deployments regardless of state.

Examples:

  • Basic usage with minimal filters
gmctl deployment lambda get -re us-east-1 -fn my-function
  • Filter deployments by repository and status
gmctl deployment lambda get -r https://github.com/example/repo -st PROCESSED_SUCCESS
  • View detailed information for failed deployments
gmctl deployment lambda get -fn my-function -v
  • Show detailed information for all deployments
gmctl deployment lambda get -fn my-function -v -A
  • Limit the number of results
gmctl deployment lambda get -fn my-function --n 5

Commit Management

Commands for working with Git commits in Gitmoxi.

gmctl commit [SUBCOMMAND]

Get commit

Retrieve the latest commits from the specified repository and branch.

gmctl commit get [OPTIONS]
OptionRequiredDescription
-r, --repo-urlYesThe URL of the repository
-b, --branchYesThe branch to retrieve commits from
-n, --nNoThe number of commits to retrieve (default: 1)

This will display a table of the most recent commits with the following information:

  • commit_hash
  • repo_url
  • branch
  • receive_timestamp
  • status

Example:

gmctl commit get -r https://github.com/example/repo -b main -n 5

Deploy commit

Deploy the latest commit from the specified repository and branch.

gmctl commit deploy -r REPO_URL -b BRANCH [-f] [-v]
OptionRequiredDescription
-r, --repo-urlYesThe URL of the repository
-b, --branchYesThe branch to deploy from
-f, --forceNoForce deployment of the last known commit if there are no changes
-v, --verboseNoEnable verbose output

This will deploy the latest commit and display a table of affected files including:

  • latest_commit_hash
  • previous_processed_commit_hash
  • file
  • change (added_or_modified/deleted)
  • relevance (ecs/lambda)

Example

gmctl commit deploy -r https://github.com/example/repo -b main --force

Dryrun for a commit

Perform a dry run to identify changes in the specified repository and branch without deploying.

gmctl commit dryrun [OPTIONS]
OptionRequiredDescription
-r, --repo-urlYesThe URL of the repository
-b, --branchYesThe branch to perform the dry run on
-p, --process_templateNoProcess templates for changed files
-v, --verboseNoEnable verbose output

This will display a table of files that would be affected by deployment, including:

  • latest_commit_hash
  • previous_processed_commit_hash
  • file
  • change (added_or_modified/deleted)
  • relevance (ecs/lambda)

Example:

gmctl commit dryrun -r https://github.com/example/repo -b main -p

Relevant files for commit

Get relevant files that were processed for a specific commit.

gmctl commit files -c COMMIT_HASH
OptionRequiredDescription
-c, --commit-hashYesThe commit hash to retrieve relevant files for
This will display a table of files associated with the specified commit, including:
  • receive_timestamp
  • file
  • change (added_or_modified/deleted)
  • relevance (ecs/lambda) Example:
gmctl commit files -c abc123

Elevate Your Deployment Experience Today

Experience the power of Gitmoxi — your go-to solution for simple, flexible, and transparent deployment management

Try Now for Free

Email Address *

End User License Agreement

END USER LICENSE AGREEMENT (EULA)

IMPORTANT: PLEASE READ THIS AGREEMENT CAREFULLY BEFORE DOWNLOADING, INSTALLING, OR USING THE SOFTWARE.

By downloading, installing, or using this software, you acknowledge that you have read this Agreement, understand it, and agree to be bound by its terms. If you do not agree to these terms, do not install or use the software.

-------------------------------------------------------------------------------

1. GRANT OF LICENSE  
Subject to the terms of this Agreement, SKAI Software Corporation grants you a limited, non-exclusive, non-transferable, non-sublicensable license to install and use the software solely for your personal or internal business purposes.  

-------------------------------------------------------------------------------

2. RESTRICTIONS  
You may NOT:  
a) Modify, adapt, translate, or create derivative works from the software.  
b) Reverse engineer, decompile, or disassemble the software, except as expressly permitted by applicable law.  
c) Rent, lease, loan, sell, sublicense, distribute, or otherwise transfer the software to any third party.  
d) Remove, alter, or obscure any proprietary notices, trademarks, or labels from the software.  

-------------------------------------------------------------------------------

3. OWNERSHIP  
The software is and remains the exclusive property of SKAI Software Corporation. This Agreement does NOT transfer ownership of the software; it only grants you a limited license to use it. SKAI Software Corporation reserves all rights not expressly granted.  

-------------------------------------------------------------------------------

4. TERMINATION  
This Agreement is effective until terminated. Your rights under this Agreement will automatically terminate without notice if you violate any provision.  

Upon termination, you MUST IMMEDIATELY:  
- Cease all use of the software.  
- Delete or destroy all copies in your possession.  

Termination does not limit SKAI Software Corporation’s right to pursue any other remedies available under law or equity.  

-------------------------------------------------------------------------------

5. DISCLAIMER OF WARRANTY  
THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.  

SKAI SOFTWARE CORPORATION DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  

SKAI SOFTWARE CORPORATION DOES NOT WARRANT THAT THE SOFTWARE WILL BE ERROR-FREE, UNINTERRUPTED, OR COMPATIBLE WITH ALL SYSTEMS.  

YOU EXPRESSLY ACKNOWLEDGE AND AGREE THAT USE OF THE SOFTWARE IS AT YOUR SOLE RISK.  

-------------------------------------------------------------------------------

6. LIMITATION OF LIABILITY  
TO THE FULLEST EXTENT PERMITTED BY LAW:  

IN NO EVENT SHALL SKAI SOFTWARE CORPORATION BE LIABLE FOR ANY INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES, INCLUDING BUT NOT LIMITED TO LOST PROFITS, BUSINESS INTERRUPTION, OR LOSS OF DATA, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  

IN NO EVENT SHALL SKAI SOFTWARE CORPORATION'S TOTAL LIABILITY UNDER THIS AGREEMENT EXCEED THE AMOUNT YOU PAID FOR THE SOFTWARE, IF ANY.  

SOME JURISDICTIONS DO NOT ALLOW CERTAIN LIMITATIONS OF LIABILITY, SO SOME OF THESE LIMITATIONS MAY NOT APPLY TO YOU.  

-------------------------------------------------------------------------------

7. INDEMNIFICATION  
You agree to INDEMNIFY, DEFEND, AND HOLD HARMLESS SKAI Software Corporation, its affiliates, officers, directors, employees, and agents from any claims, liabilities, damages, costs, or expenses (including attorneys’ fees) arising out of:  
a) Your use or misuse of the software.  
b) Your violation of this Agreement.  
c) Your violation of any applicable laws or third-party rights.  

-------------------------------------------------------------------------------

8. GOVERNING LAW & JURISDICTION  
This Agreement shall be governed by and construed in accordance with the LAWS OF THE STATE OF DELAWARE, U.S.A., WITHOUT REGARD TO ITS CONFLICT OF LAW PRINCIPLES.  

ANY DISPUTE ARISING FROM OR RELATED TO THIS AGREEMENT SHALL BE EXCLUSIVELY RESOLVED IN THE STATE OR FEDERAL COURTS LOCATED IN DELAWARE, AND YOU IRREVOCABLY CONSENT TO SUCH JURISDICTION.  

-------------------------------------------------------------------------------

9. SEVERABILITY  
If any provision of this Agreement is found to be invalid or unenforceable, the remaining provisions shall remain in full force and effect.  

-------------------------------------------------------------------------------

10. FORCE MAJEURE  
SKAI Software Corporation shall NOT BE LIABLE for any failure or delay in performance due to causes beyond its reasonable control, including but not limited to natural disasters, war, government actions, network failures, or cyber-attacks.  

-------------------------------------------------------------------------------

11. ENTIRE AGREEMENT  
This Agreement constitutes the ENTIRE AGREEMENT between you and SKAI Software Corporation regarding the software and supersedes all prior agreements, representations, or understandings.  

-------------------------------------------------------------------------------

BY DOWNLOADING, INSTALLING, OR USING THIS SOFTWARE, YOU ACKNOWLEDGE THAT YOU HAVE READ AND UNDERSTOOD THIS AGREEMENT AND AGREE TO BE BOUND BY ITS TERMS.

I have read and accept the End User License Agreement

×