Merge pull request #14 from nao1215/doc/cfn

Add specification document for cfn command
nao1215 · Jan 1, 2024 · b2e2caf · b2e2caf
2 parents 34262af + 1e517a4
commit b2e2caf
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
-## [](https://github.com/nao1215/rainbow/compare/77bdf974281a...) (2023-12-29)
+## [](https://github.com/nao1215/rainbow/compare/77bdf974281a...) (2024-01-01)
 
+* Introduce spare command [#13](https://github.com/nao1215/rainbow/pull/13) ([nao1215](https://github.com/nao1215))
+* build(deps): bump golang.org/x/sync from 0.1.0 to 0.5.0 [#12](https://github.com/nao1215/rainbow/pull/12) ([dependabot[bot]](https://github.com/apps/dependabot))
+* Update document for s3hub with gif image [#11](https://github.com/nao1215/rainbow/pull/11) ([nao1215](https://github.com/nao1215))
 * Add remove subcommand [#10](https://github.com/nao1215/rainbow/pull/10) ([nao1215](https://github.com/nao1215))
 * Add ls subcommand [#9](https://github.com/nao1215/rainbow/pull/9) ([nao1215](https://github.com/nao1215))
 * Add s3hub mb subcommand [#8](https://github.com/nao1215/rainbow/pull/8) ([nao1215](https://github.com/nao1215))

diff --git a/README.md b/README.md
@@ -25,8 +25,9 @@ The rainbow project is a toolset for managing AWS resources. This project consis
 [WIP]
 |Name|README|implementation|Description|
 |:--|:--|:--|:--|
-|[s3hub](./doc/s3hub/README.md)|✅||User-friendly s3 management tool|
-|[spare](./doc/spare/README.md)|✅||Single Page Application Release Easily|
+|[s3hub](./doc/s3hub/README.md)|✅|60%|User-friendly s3 management tool|
+|[spare](./doc/spare/README.md)|✅|50%|Single Page Application Release Easily|
+|[cfn](./doc/cfn/README.md)|✅|0%|List up or delete CloudFormation stacks|
 
 ### s3hub example
 #### Create a bucket(s)

diff --git a/doc/cfn/README.md b/doc/cfn/README.md
@@ -0,0 +1,38 @@
+## cfn - list up or delete CloudFormation stacks
+> [!IMPORTANT]
+> Not implemented yet. This is specifiction document.
+
+The cfn command provides the following features:
+- [ ] List stacks
+- [ ] Delete stacks
+- [ ] Add tags to stacks
+- [ ] Interactive mode
+
+### How to install
+```shell
+go install github.com/nao1215/rainbow/cmd/cfn@latest
+```
+
+### How to use
+The cfn command allows you to specify a profile as an option, but it is more user-friendly to use the `AWS_PROFILE` environment variable.
+
+### List stacks
+```shell
+cfn ls
+```
+
+### Delete stacks
+```shell
+cfn rm ${STACK_NAME}
+```
+
+### Add tags to stacks
+```shell
+cfn tag ${STACK_NAME} ${TAG_KEY}=${TAG_VALUE}
+```
+
+### Interactive mode
+```shell
+cfn
+```
+