shipit-cli 0.19.0__tar.gz → 0.19.2__tar.gz

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shipit-cli
-Version: 0.19.0
+Version: 0.19.2
 Summary: Shipit CLI is the best way to build, serve and deploy your projects anywhere.
 Project-URL: homepage, https://wasmer.io
 Project-URL: repository, https://github.com/wasmerio/shipit
@@ -37,12 +37,13 @@ Install nothing globally; use `uvx shipit-cli` to run Shipit from anywhere.
 uvx shipit-cli .
 ```
 
-Running in `auto` mode will generate the `Shipit` file when needed, build the project, and can
-also serve it. Shipit picks the safest builder automatically and falls back to
-Docker or Wasmer when requested:
+Running in `auto` mode will generate the `Shipit` file when needed, build the
+project, and can also run it. Shipit picks the safest builder automatically
+and falls back to Docker or Wasmer when requested:
 
-- `uvx shipit-cli . --wasmer` builds locally and serves inside Wasmer.
-- `uvx shipit-cli . --docker` builds it with Docker (you can customize the docker client as well, eg: `--docker-client depot`).
+- `uvx shipit-cli . --wasmer` builds locally and runs inside Wasmer.
+- `uvx shipit-cli . --docker` builds it with Docker (you can customize the
+  docker client as well, eg: `--docker-client depot`).
 - `uvx shipit-cli . --start` launches the app after building.
 
 You can combine them as needed:
@@ -56,8 +57,7 @@ uvx shipit-cli . --start --wasmer --skip-prepare
 ### Default `auto` mode
 
 Full pipeline in one command. Combine flags such as `--regenerate` to rewrite
-the `Shipit` file. Use
-`--wasmer` to run with Wasmer, or `--wasmer-deploy` to deploy to Wasmer Edge.
+the `Shipit` file. Use `--wasmer` to run with Wasmer.
 
 ### `generate`
 
@@ -87,13 +87,24 @@ uvx shipit-cli build
 Run the build steps defined in `Shipit`. Append `--wasmer` to execute inside
 Wasmer, `--docker` to use Docker builds.
 
-### `serve`
+### `run`
 
 ```bash
-uvx shipit-cli serve
+uvx shipit-cli run
 ```
 
-Execute the start command for the project. Combine with `--wasmer` for WebAssembly execution, or `--wasmer-deploy` to deploy to Wasmer Edge.
+Run explicit commands for the project. Use `--start` to run the start
+command, or pass one or more `--command` values. Combine with `--wasmer`
+for WebAssembly execution.
+
+### `deploy`
+
+```bash
+uvx shipit-cli deploy
+```
+
+Deploy a Wasmer package generated by `shipit build --wasmer`. Use
+`--wasmer-deploy-config` to write deployment metadata instead of publishing.
 
 ## Supported Technologies
 

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/README.md

@@ -14,12 +14,13 @@ Install nothing globally; use `uvx shipit-cli` to run Shipit from anywhere.
 uvx shipit-cli .
 ```
 
-Running in `auto` mode will generate the `Shipit` file when needed, build the project, and can
-also serve it. Shipit picks the safest builder automatically and falls back to
-Docker or Wasmer when requested:
+Running in `auto` mode will generate the `Shipit` file when needed, build the
+project, and can also run it. Shipit picks the safest builder automatically
+and falls back to Docker or Wasmer when requested:
 
-- `uvx shipit-cli . --wasmer` builds locally and serves inside Wasmer.
-- `uvx shipit-cli . --docker` builds it with Docker (you can customize the docker client as well, eg: `--docker-client depot`).
+- `uvx shipit-cli . --wasmer` builds locally and runs inside Wasmer.
+- `uvx shipit-cli . --docker` builds it with Docker (you can customize the
+  docker client as well, eg: `--docker-client depot`).
 - `uvx shipit-cli . --start` launches the app after building.
 
 You can combine them as needed:
@@ -33,8 +34,7 @@ uvx shipit-cli . --start --wasmer --skip-prepare
 ### Default `auto` mode
 
 Full pipeline in one command. Combine flags such as `--regenerate` to rewrite
-the `Shipit` file. Use
-`--wasmer` to run with Wasmer, or `--wasmer-deploy` to deploy to Wasmer Edge.
+the `Shipit` file. Use `--wasmer` to run with Wasmer.
 
 ### `generate`
 
@@ -64,13 +64,24 @@ uvx shipit-cli build
 Run the build steps defined in `Shipit`. Append `--wasmer` to execute inside
 Wasmer, `--docker` to use Docker builds.
 
-### `serve`
+### `run`
 
 ```bash
-uvx shipit-cli serve
+uvx shipit-cli run
 ```
 
-Execute the start command for the project. Combine with `--wasmer` for WebAssembly execution, or `--wasmer-deploy` to deploy to Wasmer Edge.
+Run explicit commands for the project. Use `--start` to run the start
+command, or pass one or more `--command` values. Combine with `--wasmer`
+for WebAssembly execution.
+
+### `deploy`
+
+```bash
+uvx shipit-cli deploy
+```
+
+Deploy a Wasmer package generated by `shipit build --wasmer`. Use
+`--wasmer-deploy-config` to write deployment metadata instead of publishing.
 
 ## Supported Technologies
 

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shipit-cli"
-version = "0.19.0"
+version = "0.19.2"
 description = "Shipit CLI is the best way to build, serve and deploy your projects anywhere."
 readme = "README.md"
 requires-python = ">=3.10"

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/src/shipit/assets/wordpress/install.sh

@@ -19,7 +19,9 @@ mkdir -p wp-content/plugins
 mkdir -p wp-content/upgrade
 
 if [ -n "${WPCONTENT_BASE_PATH:-}" ] && [ -d "${WPCONTENT_BASE_PATH}" ]; then
-  cp -R "${WPCONTENT_BASE_PATH}/." /app/wp-content/
+  shopt -s dotglob nullglob
+  cp -R "${WPCONTENT_BASE_PATH}"/* /app/wp-content
+  shopt -u dotglob nullglob
 fi
 
 echo "Installing WordPress core"

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/src/shipit/cli.py

@@ -36,6 +36,12 @@ from shipit.shipit_types import (
 )
 from shipit.ui import console
 from shipit.version import version as shipit_version
+from shipit.volumes import (
+    build_volumes,
+    load_volume_mappings,
+    merge_volume_mappings,
+    parse_cli_volume_mappings,
+)
 
 app = typer.Typer(invoke_without_command=True)
 
@@ -346,7 +352,7 @@ def auto(
     ),
     wasmer: bool = typer.Option(
         False,
-        help="Use Wasmer to build and serve the project.",
+        help="Use Wasmer to build and run the project.",
     ),
     wasmer_bin: Optional[str] = typer.Option(
         None,
@@ -372,18 +378,26 @@ def auto(
         False,
         help="Run the prepare command after building (defaults to True).",
     ),
-    run_commands: Optional[List[str]] = typer.Option(
+    command_names: Optional[List[str]] = typer.Option(
+        None,
+        "-c",
+        "--command",
+        help="Run one or more commands after building. Can be passed multiple times.",
+    ),
+    volume_specs: Optional[List[str]] = typer.Option(
         None,
-        "--run",
-        help="Run one or more serve commands after building. Can be passed multiple times.",
+        "--volume",
+        help="Attach one or more volumes as NAME:/guest/path. Can be passed multiple times.",
     ),
     start: bool = typer.Option(
         False,
-        help="Equivalent to `--run=start`.",
+        "--start/--no-start",
+        help="Equivalent to `--command=start`.",
     ),
     after_deploy: bool = typer.Option(
         False,
-        help="Equivalent to `--run=after_deploy`.",
+        "--after-deploy/--no-after-deploy",
+        help="Equivalent to `--command=after_deploy`.",
     ),
     regenerate: bool = typer.Option(
         None,
@@ -397,30 +411,10 @@ def auto(
         False,
         help="Use a temporary Shipit file in the system temporary directory.",
     ),
-    wasmer_deploy: Optional[bool] = typer.Option(
-        False,
-        help="Deploy the project to Wasmer.",
-    ),
-    wasmer_deploy_config: Optional[Path] = typer.Option(
-        None,
-        help="Save the output of the Wasmer build to a json file",
-    ),
-    wasmer_token: Optional[str] = typer.Option(
-        None,
-        help="Wasmer token.",
-    ),
     wasmer_registry: Optional[str] = typer.Option(
         None,
         help="Wasmer registry.",
     ),
-    wasmer_app_owner: Optional[str] = typer.Option(
-        None,
-        help="Owner of the Wasmer app.",
-    ),
-    wasmer_app_name: Optional[str] = typer.Option(
-        None,
-        help="Name of the Wasmer app.",
-    ),
     install_command: Optional[str] = typer.Option(
         None,
         help="The install command to use (overwrites the default)",
@@ -450,9 +444,6 @@ def auto(
         help="The port to use (defaults to 8080).",
     ),
 ):
-    # We assume wasmer as an active flag if we pass wasmer deploy or wasmer deploy config
-    wasmer = wasmer or wasmer_deploy or (wasmer_deploy_config is not None)
-
     if not path.exists():
         raise Exception(f"The path {path} does not exist")
 
@@ -493,7 +484,6 @@ def auto(
         docker_opts=docker_opts,
         skip_docker_if_safe_build=skip_docker_if_safe_build,
         wasmer_registry=wasmer_registry,
-        wasmer_token=wasmer_token,
         wasmer_bin=wasmer_bin,
         skip_prepare=skip_prepare,
         env_name=env_name,
@@ -501,24 +491,25 @@ def auto(
         provider=provider,
         config=config,
     )
-    if run_commands or start or after_deploy or wasmer_deploy or wasmer_deploy_config:
-        serve(
+    if (
+        command_names
+        or volume_specs
+        or start
+        or after_deploy
+    ):
+        run(
             path,
             wasmer=wasmer,
             wasmer_bin=wasmer_bin,
             docker=docker,
             docker_client=docker_client,
-            run_commands=run_commands,
+            docker_opts=docker_opts,
+            command_names=command_names,
+            volume_specs=volume_specs,
             start=start,
             after_deploy=after_deploy,
-            wasmer_token=wasmer_token,
             wasmer_registry=wasmer_registry,
-            wasmer_deploy=wasmer_deploy,
-            wasmer_app_owner=wasmer_app_owner,
-            wasmer_app_name=wasmer_app_name,
-            wasmer_deploy_config=wasmer_deploy_config,
         )
-    # deploy(path)
 
 
 @app.command(name="generate")
@@ -601,7 +592,7 @@ def generate(
     context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
 )
 def _default(ctx: typer.Context) -> None:
-    if ctx.invoked_subcommand in ["auto", "generate", "build", "serve", "deploy", None]:
+    if ctx.invoked_subcommand in ["auto", "generate", "build", "run", "deploy", None]:
         print_help()
 
 
@@ -612,12 +603,57 @@ def deploy(
         help="Project path (defaults to current directory).",
         show_default=False,
     ),
+    wasmer_deploy: bool = typer.Option(
+        True,
+        help="Deploy the project to Wasmer.",
+    ),
+    wasmer_bin: Optional[str] = typer.Option(
+        None,
+        help="The path to the Wasmer binary.",
+    ),
+    wasmer_token: Optional[str] = typer.Option(
+        None,
+        help="Wasmer token.",
+    ),
+    wasmer_registry: Optional[str] = typer.Option(
+        None,
+        help="Wasmer registry.",
+    ),
+    wasmer_app_owner: Optional[str] = typer.Option(
+        None,
+        help="Owner of the Wasmer app.",
+    ),
+    wasmer_app_name: Optional[str] = typer.Option(
+        None,
+        help="Name of the Wasmer app.",
+    ),
+    wasmer_deploy_config: Optional[Path] = typer.Option(
+        None,
+        help="Save the output of the Wasmer build to a json file",
+    ),
 ) -> None:
-    pass
+    if not path.exists():
+        raise Exception(f"The path {path} does not exist")
+
+    build_backend = LocalBuildBackend(path, ASSETS_PATH)
+    runner = WasmerRunner(
+        build_backend,
+        path,
+        registry=wasmer_registry,
+        token=wasmer_token,
+        bin=wasmer_bin,
+    )
+
+    if wasmer_deploy_config:
+        runner.deploy_config(wasmer_deploy_config)
+        return
 
+    if wasmer_deploy:
+        runner.deploy(app_owner=wasmer_app_owner, app_name=wasmer_app_name)
 
-@app.command(name="serve")
-def serve(
+
+@app.command(name="run")
+def run(
     path: Path = typer.Argument(
         Path("."),
         help="Project path (defaults to current directory).",
@@ -625,7 +661,7 @@ def serve(
     ),
     wasmer: bool = typer.Option(
         False,
-        help="Use Wasmer to build and serve the project.",
+        help="Use Wasmer to run the project.",
     ),
     wasmer_bin: Optional[str] = typer.Option(
         None,
@@ -643,47 +679,32 @@ def serve(
         None,
         help="Additional options to pass to the Docker client.",
     ),
-    run_commands: Optional[List[str]] = typer.Option(
+    command_names: Optional[List[str]] = typer.Option(
         None,
-        "--run",
-        help="Run one or more serve commands. Can be passed multiple times.",
+        "-c",
+        "--command",
+        help="Run one or more commands. Can be passed multiple times.",
     ),
-    start: Optional[bool] = typer.Option(
-        True,
-        help="Equivalent to `--run=start`.",
+    volume_specs: Optional[List[str]] = typer.Option(
+        None,
+        "--volume",
+        help="Attach one or more volumes as NAME:/guest/path. Can be passed multiple times.",
     ),
-    after_deploy: bool = typer.Option(
+    start: bool = typer.Option(
         False,
-        help="Equivalent to `--run=after_deploy`.",
+        "--start/--no-start",
+        help="Equivalent to `--command=start`.",
     ),
-    wasmer_deploy: Optional[bool] = typer.Option(
+    after_deploy: bool = typer.Option(
         False,
-        help="Deploy the project to Wasmer.",
-    ),
-    wasmer_token: Optional[str] = typer.Option(
-        None,
-        help="Wasmer token.",
+        "--after-deploy/--no-after-deploy",
+        help="Equivalent to `--command=after_deploy`.",
     ),
     wasmer_registry: Optional[str] = typer.Option(
         None,
         help="Wasmer registry.",
     ),
-    wasmer_app_owner: Optional[str] = typer.Option(
-        None,
-        help="Owner of the Wasmer app.",
-    ),
-    wasmer_app_name: Optional[str] = typer.Option(
-        None,
-        help="Name of the Wasmer app.",
-    ),
-    wasmer_deploy_config: Optional[Path] = typer.Option(
-        None,
-        help="Save the output of the Wasmer build to a json file",
-    ),
 ) -> None:
-    # We assume wasmer as an active flag if we pass wasmer deploy or wasmer deploy config
-    wasmer = wasmer or wasmer_deploy or (wasmer_deploy_config is not None)
-
     if not path.exists():
         raise Exception(f"The path {path} does not exist")
 
@@ -699,29 +720,21 @@ def serve(
             build_backend,
             path,
             registry=wasmer_registry,
-            token=wasmer_token,
             bin=wasmer_bin,
         )
     else:
         runner = LocalRunner(build_backend, path)
 
     commands_to_run = resolve_run_commands(
-        run_commands=run_commands,
-        start=bool(start),
+        command_names=command_names,
+        start=start,
         after_deploy=after_deploy,
     )
 
-    if wasmer_deploy_config:
-        if not isinstance(runner, WasmerRunner):
-            raise RuntimeError("--wasmer-deploy-config requires the Wasmer runner")
-        runner.deploy_config(wasmer_deploy_config)
-    elif wasmer_deploy:
-        if not isinstance(runner, WasmerRunner):
-            raise RuntimeError("--wasmer-deploy requires the Wasmer runner")
-        runner.deploy(app_owner=wasmer_app_owner, app_name=wasmer_app_name)
-    elif commands_to_run:
-        run_serve_commands(runner, commands_to_run)
-
+    if commands_to_run:
+        run_serve_commands(path, runner, commands_to_run, volume_specs=volume_specs)
+    else:
+        console.print("[bold]No commands specified. Use `--command` to run a command.[/bold]")
 
 @app.command(name="plan")
 def plan(
@@ -927,7 +940,7 @@ def build(
     ),
     wasmer: bool = typer.Option(
         False,
-        help="Use Wasmer to build and serve the project.",
+        help="Use Wasmer to build and package the project.",
     ),
     skip_prepare: bool = typer.Option(
         False,
@@ -1073,8 +1086,10 @@ def build(
 
     # Build and serve
     build_backend.build(serve.name, env, serve.mounts or [], build_steps)
+    build_volumes(path, serve)
     runner.build(serve)
     if serve.prepare and not skip_prepare:
+        console.print("\n[bold]Running prepare step[/bold]")
         runner.prepare(env, serve.prepare)
 
 
@@ -1093,11 +1108,11 @@ def get_shipit_path(path: Path, shipit_path: Optional[Path] = None) -> Path:
 
 
 def resolve_run_commands(
-    run_commands: Optional[List[str]],
+    command_names: Optional[List[str]],
     start: bool,
     after_deploy: bool,
 ) -> List[str]:
-    commands = list(run_commands or [])
+    commands = list(command_names or [])
     if after_deploy and "after_deploy" not in commands:
         commands.append("after_deploy")
     if start and "start" not in commands:
@@ -1105,12 +1120,21 @@ def resolve_run_commands(
     return commands
 
 
-def run_serve_commands(runner: Runner, commands: List[str]) -> None:
+def run_serve_commands(
+    path: Path,
+    runner: Runner,
+    commands: List[str],
+    volume_specs: Optional[List[str]] = None,
+) -> None:
+    volume_mappings = merge_volume_mappings(
+        load_volume_mappings(path),
+        parse_cli_volume_mappings(volume_specs),
+    )
     for command in commands:
         if command in OPTIONAL_RUN_COMMANDS and not runner.has_serve_command(command):
             continue
-        runner.run_serve_command(command)
-
+        console.print(f"\nRunning command [bold]{command}[/bold]")
+        runner.run_serve_command(command, volume_mappings=volume_mappings)
 
 def main() -> None:
     args = sys.argv[1:]

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/src/shipit/providers/php.py

@@ -141,6 +141,10 @@ class PhpProvider:
         )
         if not config.framework:
             config.framework = cls.detect_framework(path, composer_config)
+        if config.framework == PhpFramework.Drupal:
+            # Drupal relies on Apache-style rewrite behavior that the built-in
+            # php server handles more predictably than phpix by default.
+            config.phpix = False
         return config
 
     @classmethod

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/src/shipit/runners/base.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Dict, List, Protocol, TYPE_CHECKING
+from typing import Dict, List, Optional, Protocol, TYPE_CHECKING
 
 from shipit.builders.base import BuildBackend
 
@@ -15,5 +15,9 @@ class Runner(Protocol):
     def build(self, serve: "Serve") -> None: ...
     def prepare(self, env: Dict[str, str], prepare: List["PrepareStep"]) -> None: ...
     def has_serve_command(self, command: str) -> bool: ...
-    def run_serve_command(self, command: str) -> None: ...
+    def run_serve_command(
+        self,
+        command: str,
+        volume_mappings: Optional[Dict[str, str]] = None,
+    ) -> None: ...
     def get_serve_mount_path(self, name: str) -> Path: ...

{shipit_cli-0.19.0 → shipit_cli-0.19.2}/src/shipit/runners/local.py

@@ -1,6 +1,6 @@
 import shutil
 from pathlib import Path
-from typing import Dict, List, TYPE_CHECKING
+from typing import Dict, List, Optional, TYPE_CHECKING
 
 import sh
 from rich import box
@@ -21,7 +21,7 @@ class LocalRunner:
         self.build_backend = build_backend
         self.src_dir = src_dir
         self.runner_path = self.src_dir / ".shipit" / "runner" / "local"
-        self.serve_bin_path = self.runner_path / "serve" / "bin"
+        self.serve_bin_path = self.runner_path / "bin"
         self.prepare_bash_script = self.runner_path / "prepare" / "prepare.sh"
 
     def prepare_config(self, provider_config: object) -> object:
@@ -37,30 +37,6 @@ class LocalRunner:
         self.build_prepare(serve)
         self.build_serve(serve)
 
-    def _prepare_volumes(self, serve: Serve) -> None:
-        for volume in serve.volumes or []:
-            source = volume.path.absolute()
-            target = volume.serve_path
-
-            source.mkdir(parents=True, exist_ok=True)
-
-            if target.is_symlink():
-                if target.resolve(strict=False) == source.resolve():
-                    continue
-                target.unlink()
-            elif target.exists():
-                if target.is_dir():
-                    if not any(source.iterdir()):
-                        shutil.copytree(target, source, dirs_exist_ok=True)
-                    shutil.rmtree(target)
-                else:
-                    if not any(source.iterdir()):
-                        shutil.copy2(target, source / target.name)
-                    target.unlink()
-
-            target.parent.mkdir(parents=True, exist_ok=True)
-            target.symlink_to(source, target_is_directory=True)
-
     def build_prepare(self, serve: Serve) -> None:
         if not serve.prepare:
             return
@@ -93,7 +69,6 @@ class LocalRunner:
 
     def build_serve(self, serve: Serve) -> None:
         console.print("\n[bold]Building serve[/bold]")
-        self._prepare_volumes(serve)
         shutil.rmtree(self.serve_bin_path.parent, ignore_errors=True)
         self.serve_bin_path.mkdir(parents=True, exist_ok=True)
         runtime_path = self.build_backend.get_runtime_path() or ""
@@ -133,7 +108,10 @@ class LocalRunner:
     def has_serve_command(self, command: str) -> bool:
         return (self.serve_bin_path / command).is_file()
 
-    def run_serve_command(self, command: str) -> None:
-        console.print(f"\n[bold]Running {command} command[/bold]")
+    def run_serve_command(
+        self,
+        command: str,
+        volume_mappings: Optional[Dict[str, str]] = None,
+    ) -> None:
         command_path = self.serve_bin_path / command
         sh.Command(str(command_path))(_out=write_stdout, _err=write_stderr)