Method format_examples

samcli/commands/init/core/command.py:22–81

(ctx: Context, formatter: CommandHelpTextFormatter)

    @staticmethod
    def format_examples(ctx: Context, formatter: CommandHelpTextFormatter):
        with formatter.indented_section(name="Examples", extra_indents=1):
            with formatter.indented_section(name="Interactive Mode", extra_indents=1):
                formatter.write_text_rows(
                    [
                        RowDefinition(name=style(f"$ {ctx.command_path}"), extra_row_modifiers=[ShowcaseRowModifier()]),
                    ]
                )
            with formatter.indented_section(name="Customized Interactive Mode", extra_indents=1):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --name sam-app --runtime nodejs18.x --architecture arm64"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --name sam-app --runtime nodejs18.x --dependency-manager "
                                f"npm --app-template hello-world"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --name sam-app --package-type image --architecture arm64"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )
            with formatter.indented_section(name="Direct Initialization", extra_indents=1):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} --location gh:aws-samples/cookiecutter-aws-sam-python"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --location "
                                f"git+ssh://git@github.com/aws-samples/cookiecutter-aws-sam-python.git"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} --location /path/to/template.zip"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} --location /path/to/template/directory"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} --location https://example.com/path/to/template.zip"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),