--script and --lib flags

CHANGELOG.md

@@ -7,6 +7,8 @@ that were not yet released.
 
 _Unreleased_
 
+- `init` now supports `--script` and `--lib` to generate a script or library project.  #738
+
 - Fixed `rye config --show-path` abort with an error. #706
 
 - Bumped `uv` to 0.1.7.  #719, #740

docs/guide/basics.md

@@ -136,3 +136,38 @@ virtualenv is located and more.
 ```
 rye show
 ```
+
+## Executable projects
+
+To generate a project that is aimed to provide an executable
+script, use `rye init --script`:
+
+```shell
+rye init --script my-project
+cd my-project
+```
+
+The following structure will be created:
+
+```
+.
+├── .git
+├── .gitignore
+├── .python-version
+├── README.md
+├── pyproject.toml
+└── src
+    └── my_project
+        └── __init__.py
+        └── __main__.py
+```
+
+The [`pyproject.toml`](pyproject.md) will be generated with a
+[`[project.scripts]`](pyproject.md#projectscripts) section named `hello`
+that points to the `main()` function of `__init__.py`. After you
+synchronized your changes, you can run the script with `rye run my-project`.
+
+```shell
+rye sync
+rye run hello
+```