https://github.com/aws/aws-sam-cli-app-templates
https://github.com/aws/aws-sam-cli-app-templates
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aws/aws-sam-cli-app-templates
- Owner: aws
- License: apache-2.0
- Created: 2019-09-27T16:42:59.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-21T19:14:33.000Z (over 1 year ago)
- Last Synced: 2025-04-06T19:09:19.473Z (about 1 year ago)
- Language: Python
- Size: 21.5 MB
- Stars: 506
- Watchers: 26
- Forks: 260
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# AWS SAM CLI Application Templates
This repository contains the application templates used in the AWS SAM CLI for `sam init` calls.
## Contributing
We welcome issue reports and pull requests to help improve these application templates.
### Testing a template locally
You can create a buildable and deployable project folder from a local template using the below command. The `` can be whatever you want your project to be called, and `` should point to the existing folder that contains the template.
Command: `sam init --no-input --location --name `
For example: `samdev init --no-input --location /home/myuser/code/aws-sam-cli-app-templates/dotnet8/hello-native-aot --name beauNativeAotTest`
### Testing updated `sam init` locally
To test an updated workflow of `sam init`, including changes to the prompts to create your new template, you need to push your changes from your fork so they can be downloaded by the SAM CLI. You'll also need a local copy of SAM CLI's source code to modify to point to your fork. Follow SAM CLI's main [DEVELOPMENT_GUIDE.md](https://github.com/aws/aws-sam-cli/blob/develop/DEVELOPMENT_GUIDE.md) to get a local version of SAM CLI setup. With your fork pushed, you can update the [samcli/commands/init/init_templates.py](https://github.com/aws/aws-sam-cli/blob/49fb8f9ad60d1daee67ebc8045266c965a125b3c/samcli/commands/init/init_templates.py#L38-L42) file in your local SAM CLI like below. Make sure to update all three variables.
```
APP_TEMPLATES_REPO_COMMIT =
MANIFEST_URL = (
f"https://raw.githubusercontent.com//aws-sam-cli-app-templates/{APP_TEMPLATES_REPO_COMMIT}/manifest-v2.json"
)
APP_TEMPLATES_REPO_URL = "https://github.com//aws-sam-cli-app-templates"
```
Example
```
APP_TEMPLATES_REPO_COMMIT = "abcdefg1234567d6e78f319e189d39593c628b7f"
MANIFEST_URL = (
f"https://raw.githubusercontent.com/aws/aws-sam-cli-app-templates/abcdefg1234567d6e78f319e189d39593c628b7f/manifest-v2.json"
)
APP_TEMPLATES_REPO_URL = "https://github.com/cool-developer-xyz/aws-sam-cli-app-templates"
```
## License
This project is licensed under the Apache-2.0 License.