https://github.com/itprokyle/ssm-dox

CLI tool for building and publishing SSM Documents.
https://github.com/itprokyle/ssm-dox

aws cli ssm-document

Last synced: 3 months ago
JSON representation

CLI tool for building and publishing SSM Documents.

• Host: GitHub
• URL: https://github.com/itprokyle/ssm-dox
• Owner: ITProKyle
• License: apache-2.0
• Created: 2021-03-09T13:55:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-03-03T21:41:09.000Z (3 months ago)
• Last Synced: 2025-03-10T15:14:37.644Z (3 months ago)
• Topics: aws, cli, ssm-document
• Language: Python
• Homepage: https://ssm-dox.readthedocs.io
• Size: 150 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ssm-dox

[![PyPi](https://img.shields.io/pypi/v/ssm-dox?style=flat)](https://pypi.org/project/ssm-dox/)

[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)

[![Documentation Status](https://readthedocs.org/projects/ssm-dox/badge/?version=latest)](https://ssm-dox.readthedocs.io/en/latest/?badge=latest)

CLI tool for building and publishing SSM Documents.

## What Is Dox?

**Dox** is a directory containing the source code of an SSM document.

Named for it's corresponding SSM Document, the directory contains the following:

- ``template.yaml`` or ``template.yml`` file **[REQUIRED]**

- ``README.md`` file describing the SSM Document

- external files to be included in the SSM Document (e.g. shell or PowerShell scripts)

## Why Use Dox?

Using **Dox** to write an SSM Document allows for scripts and other items to be linted and tested outside of the SSM Document.

This enables CI/CD pipelines to easily validate the code before it gets deployed to AWS.