Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ infra/ # AWS CDK infrastructure stacks
compose.yml # LocalStack container configuration
```

## Renaming the Template
## Initializing the Template

To rename the project from the default `templates` name, run:
To initialize the project from the default `templates` name, run:

```bash
mise run rename --name="my-project" --description="My description" --author="Name" --email="handle" --github="username"
mise run init --name="my-project" --description="My description" --author="Name" --email="handle" --github="username"
```

## Dependencies
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ Click the button below (or [use this link](https://github.com/amrabed/aws-lambda

[![Use this template](https://img.shields.io/badge/Use%20this%20template-238636?style=for-the-badge)](https://github.com/amrabed/aws-lambda-templates/generate)

### Rename the project
Run `mise run rename` once after cloning, before any other setup steps:
### Initialize the project
Run `mise run init` once after cloning, before any other setup steps:

```bash
mise run rename --name="my-project" --description="My project description" --author="Jane Doe" --email="jane" --github="janedoe"
mise run init --name="my-project" --description="My project description" --author="Jane Doe" --email="jane" --github="janedoe"
```

Pass the following parameters:
Expand Down
6 changes: 3 additions & 3 deletions mise.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@ arg "<template>" help="Template name"
run = "uv run new -n $usage_template"
alias = "n"

[tasks.rename]
description = "Rename project (run once)"
[tasks.init]
description = "Initialize project (run once)"
usage = """
flag "--name <name>" help="Project new name"
flag "--description <description>" help="Project short description"
flag "--author <author>" help="Author name"
flag "--email <email>" help="Author email"
flag "--github <github>" help="GitHub username"
"""
run = "uv run rename"
run = "uv run init"

##### Dev setup and maintenance #####

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ dependencies = [

[project.scripts]
new = "scripts.new:main"
rename = "scripts.rename:main"
init = "scripts.init:main"

[dependency-groups]
infra = [
Expand Down
2 changes: 1 addition & 1 deletion scripts/rename.py → scripts/init.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def main(name: str, description: str, author: str, email: str, github: str):
for file in files:
if file.endswith((".py", ".md", ".yml", ".pyt", ".toml")):
path = Path(root) / file
if path.name == "rename.py":
if path.name == "init.py":
continue

content = path.read_text()
Expand Down