dirigent-cli 0.9.2__tar.gz → 0.9.4__tar.gz

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dirigent-cli
-Version: 0.9.2
+Version: 0.9.4
 Summary: The dirigent command line interface (dirigent / dg).
 License-Expression: LicenseRef-Proprietary
 License-File: LICENSE
@@ -11,6 +11,7 @@ Requires-Dist: dirigent-core
 Requires-Dist: dirigent-plugin
 Requires-Dist: dirigent-server
 Requires-Dist: httpx2>=2.12.0
+Requires-Dist: python-dotenv>=1.1.0
 Requires-Dist: pyyaml>=6.0.3
 Requires-Dist: rich>=15.0.0
 Requires-Dist: tomli-w>=1.2.0

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dirigent-cli"
-version = "0.9.2"
+version = "0.9.4"
 description = "The dirigent command line interface (dirigent / dg)."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -14,6 +14,7 @@ dependencies = [
     "dirigent-plugin",
     "dirigent-server",
     "httpx2>=2.12.0",
+    "python-dotenv>=1.1.0",
     "pyyaml>=6.0.3",
     "rich>=15.0.0",
     "tomli-w>=1.2.0",

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "dirigent-cli"
-version = "0.9.2"
+version = "0.9.4"
 description = "The dirigent command line interface (dirigent / dg)."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -14,6 +14,7 @@ dependencies = [
     "dirigent-plugin",
     "dirigent-server",
     "httpx2>=2.12.0",
+    "python-dotenv>=1.1.0",
     "pyyaml>=6.0.3",
     "rich>=15.0.0",
     "tomli-w>=1.2.0",

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/src/dirigent_cli/commands.py

@@ -56,7 +56,14 @@ from dirigent_cli.output import (
     table,
 )
 from dirigent_cli.params import ParamError, build_params
-from dirigent_cli.project import COMPOSE_TEMPLATE_NAME, ProjectError, check_template, find_project, scaffold
+from dirigent_cli.project import (
+    COMPOSE_TEMPLATE_NAME,
+    ProjectError,
+    check_template,
+    find_project,
+    scaffold,
+    write_token_env,
+)
 from dirigent_cli.scaffold import ScaffoldedRecord, ScaffoldError, ScaffoldRecord, scaffold_pack
 from dirigent_cli.sources import Document, SourceError, looks_like_a_document, read_document, read_path
 from dirigent_cli.stream import Sink, track_steps, use_scratch_prefix
@@ -546,6 +553,7 @@ def init_command(
     migrated = migrations.head_revision(settings) or "none"
     migrations.upgrade("head", settings)
     token = asyncio.run(first_admin(settings, admin, secret))
+    env_file = write_token_env(root, token)
     emit_fact(
         "instance.initialised",
         message="initialised",
@@ -556,7 +564,7 @@ def init_command(
         admin=admin,
         token=token,
         version=version,
-        files=[_within(path, root) for path in made.files],
+        files=[_within(path, root) for path in [*made.files, env_file]],
         **({"skipped": [_within(path, root) for path in made.skipped]} if made.skipped else {}),
     )
 
@@ -600,7 +608,7 @@ def _refuse_an_existing_instance(root: Path) -> None:
         _init_fail(
             f"{existing} already exists, so this directory holds an instance already",
             problems=[
-                "dg dev --keep-state starts it",
+                "dg dev starts it",
                 "dg db upgrade brings its schema forward",
                 "dg init --documents-only scaffolds documents beside it",
             ],

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/src/dirigent_cli/context.py

@@ -4,6 +4,7 @@ import logging
 import os
 from collections.abc import Awaitable
 from functools import cached_property
+from urllib.parse import urlsplit
 
 import typer
 from pydantic import BaseModel, ConfigDict
@@ -17,7 +18,7 @@ from dirigent_cli.output import (
 )
 from dirigent_cli.profiles import Endpoint, ProfileError, resolve_endpoint
 from dirigent_cli.stream import ansi
-from dirigent_client import BlockingDirigent, DirigentError
+from dirigent_client import BlockingDirigent, DirigentError, TransportError
 from dirigent_core.logging import NOISY_LOGGERS, configure_logging
 from dirigent_core.protocol import Format
 
@@ -115,6 +116,17 @@ def state_of(ctx: typer.Context) -> CliState:
     return found if found is not None else CliState()
 
 
+#: What a refused connection to a loopback address adds: the local instance is not running.
+LOCAL_INSTANCE_HINT = "nothing is listening there; uv run dg dev in the project starts its instance"
+
+LOOPBACK_HOSTS = frozenset({"127.0.0.1", "localhost", "::1"})
+
+
+def _is_local(url: str | None) -> bool:
+    """Whether a URL addresses this machine, where a refused connection means nothing is running."""
+    return bool(url) and (urlsplit(url or "").hostname or "") in LOOPBACK_HOSTS
+
+
 class Session(BlockingDirigent):
     """The SDK, driven from the CLI's synchronous commands."""
 
@@ -125,6 +137,8 @@ class Session(BlockingDirigent):
         except DirigentError as error:
             if error.problem is not None:
                 write_refusal(error.problem)
+            elif isinstance(error, TransportError) and _is_local(error.url):
+                refuse(error.message, problems=[LOCAL_INSTANCE_HINT])
             else:
                 refuse(error.message, status=error.status or 1)
             raise typer.Exit(code=1) from error

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/src/dirigent_cli/main.py

@@ -810,18 +810,16 @@ def dev(
         bool,
         typer.Option(
             "--wipe-state/--keep-state",
-            help="Delete the state directory before starting, or keep what the last run left.",
+            help="Delete the state directory before starting, instead of running the instance that is there.",
         ),
-    ] = True,
+    ] = False,
 ) -> None:
     """Run the API and an embedded worker in one process, on SQLite, with no dependencies.
 
     The database and the artifacts live in .dirigent/state under the working directory, so
     starting this somewhere else means a different instance, with none of the same runs.
-
-    That directory is deleted on every start unless --keep-state says otherwise: SQLite here
-    is a development artifact, and a database left over from an older schema answers
-    strangely rather than failing. Only a directory dirigent named itself is removed.
+    An instance that is there, made by dg init or by an earlier start, is the one that runs;
+    --wipe-state deletes it first, and only a directory dirigent named itself is removed.
     """
     import asyncio
     import os
@@ -879,10 +877,10 @@ def clear_state(settings: Settings) -> Path | None:
 
 
 def state_cleared(directory: Path) -> Record:
-    """Build the record saying the state went, and how to have kept it.
+    """Build the record saying the state went, as --wipe-state asked.
 
-    Emitted only when something was actually deleted, so a first start on an empty machine
-    stays quiet.
+    Emitted only when something was actually deleted, so a wipe of an empty machine stays
+    quiet.
     """
     return make(
         "process",
@@ -890,7 +888,6 @@ def state_cleared(directory: Path) -> Record:
         message="state cleared",
         process="dev",
         state=str(directory),
-        hint="--keep-state keeps it",
     )
 
 

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/src/dirigent_cli/profiles.py

@@ -12,12 +12,14 @@ from pathlib import Path
 from typing import Any, Final, cast
 
 import yaml
+from dotenv import dotenv_values
 from pydantic import BaseModel, ConfigDict, Field, SecretStr, model_validator
 
 from dirigent_client import API_PREFIX
 from dirigent_common import EntityName
 
 PROJECT_PROFILES: Final = Path(".dirigent") / "profiles.yaml"
+PROJECT_ENV_FILE: Final = ".env"
 USER_PROFILES: Final = Path.home() / ".config" / "dirigent" / "profiles.yaml"
 
 URL_ENV: Final = "DG_URL"
@@ -109,6 +111,21 @@ class ProfileStore(BaseModel):
     profiles: dict[EntityName, Profile] = Field(default_factory=dict[str, Profile])
     path: Path | None = None
 
+    @property
+    def env_file(self) -> Path | None:
+        """The ``.env`` at the root of the project this file belongs to, or none for the user file."""
+        if self.path is None or self.path.parent.name != PROJECT_PROFILES.parent.name:
+            return None
+        return self.path.parent.parent / PROJECT_ENV_FILE
+
+    def environment(self, environ: Mapping[str, str]) -> dict[str, str]:
+        """The environment a profile resolves in: the process's, with the project's ``.env`` filling gaps."""
+        path = self.env_file
+        if path is None or not path.is_file():
+            return dict(environ)
+        from_file = {key: value for key, value in dotenv_values(path).items() if value is not None}
+        return {**from_file, **environ}
+
     def select(self, name: str | None) -> Profile | None:
         """Choose a profile by name, by the file's default, or by there being only one."""
         wanted = name or self.default
@@ -189,11 +206,12 @@ def resolve_endpoint(
 ) -> Endpoint:
     """Resolve the server and token: flags first, then ``DG_*``, then the selected profile.
 
+    A project's ``.env`` stands in for any ``DG_*`` variable the environment does not set.
     With ``needs_token`` off, a profile whose token cannot be resolved yields no token rather
     than refusing, which is what the command that mints one asks for.
     """
-    env = environ if environ is not None else dict(os.environ)
     store = find_store(start)
+    env = store.environment(environ if environ is not None else os.environ)
     chosen = store.select(profile or env.get(PROFILE_ENV))
 
     if url is not None:

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/src/dirigent_cli/project.py

@@ -477,14 +477,17 @@ ROOT_IGNORE_TEMPLATE = """\
 # The environment uv sync builds from pyproject.toml.
 .venv/
 __pycache__/
-"""
 
-#: Appended to the root ignore by the template whose .env holds the instance key.
-COMPOSE_IGNORE_TEMPLATE = """\
-# Holds this instance's key and its first admin's password.
+# This instance's token, or the stack's key and first password. Never shared.
 .env
 """
 
+TOKEN_ENV_TEMPLATE = """\
+# The token dg init minted for this instance's first admin. The local profile in
+# .dirigent/profiles.yaml reads it from here when the shell does not export it.
+DG_TOKEN=__TOKEN__
+"""
+
 PYPROJECT_TEMPLATE = """\
 [project]
 name = "__NAME__"
@@ -516,13 +519,13 @@ __RUN__
 README_RUN: Final = {
     "basic": (
         "uv sync",
-        "uv run dg dev --keep-state",
+        "uv run dg dev",
         "uv run dg apply",
         "uv run dg run hello-world --watch",
     ),
     "ci": (
         "uv sync",
-        "uv run dg dev --keep-state",
+        "uv run dg dev",
         "uv run dg apply",
         "uv run dg run hello-world --watch",
     ),
@@ -585,10 +588,7 @@ def scaffold(
     _record(directory / "pyproject.toml", pyproject, written, skipped)
     readme = README_TEMPLATE.replace("__NAME__", name).replace("__RUN__", "\n".join(README_RUN[template]))
     _record(directory / "README.md", readme, written, skipped)
-    ignore = ROOT_IGNORE_TEMPLATE
-    if template == COMPOSE_TEMPLATE_NAME:
-        ignore += "\n" + COMPOSE_IGNORE_TEMPLATE
-    _merge_ignore(directory / ".gitignore", ignore, written, skipped)
+    _merge_ignore(directory / ".gitignore", ROOT_IGNORE_TEMPLATE, written, skipped)
     if template == "ci":
         written.append(_write(directory / ".github" / "workflows" / "dirigent.yml", WORKFLOW_TEMPLATE))
     if template == COMPOSE_TEMPLATE_NAME:
@@ -603,6 +603,11 @@ def scaffold(
     return Scaffolded(files=written, skipped=skipped)
 
 
+def write_token_env(directory: Path, token: str) -> Path:
+    """Write the ``.env`` holding a new instance's token, readable by its owner alone."""
+    return _write(directory / ".env", TOKEN_ENV_TEMPLATE.replace("__TOKEN__", token), mode=0o600)
+
+
 def _record(path: Path, content: str, written: list[Path], skipped: list[Path]) -> None:
     """Write a file a project may already have of its own, leaving any existing one alone."""
     if path.exists():

{dirigent_cli-0.9.2 → dirigent_cli-0.9.4}/src/dirigent_cli/summaries.py

@@ -285,12 +285,17 @@ def _initialised(record: Record) -> RenderableType | None:
             },
         )
     )
+    admin = escape(str(record.get("admin") or "admin"))
     parts.append(
-        "\nThe token is shown once and never stored in readable form. Keep it:"
-        f"\n  [bold]export DG_TOKEN={token}[/]"
-        "\n\nBuild the project's environment, start it, apply the example, run it:"
+        "\nThe instance lives in this directory. Its database is .dirigent/state, and the"
+        f"\ntoken of its first admin, [bold]{admin}[/], is in .env, where the local profile reads it."
+        "\nShown here once:"
+        f"\n  [bold]{token}[/]"
+        "\n\nStart the instance in a second terminal here; it keeps running:"
         "\n  [bold]uv sync[/]"
-        "\n  [bold]uv run dg dev --keep-state[/]  [dim]# plain dg dev starts by emptying .dirigent/state[/]"
+        "\n  [bold]uv run dg dev[/]"
+        f"\nThe UI is at http://127.0.0.1:3333, and {admin} logs in with the password you gave."
+        "\n\nThen apply the example here, and run it:"
         "\n  [bold]uv run dg apply[/]"
         "\n  [bold]uv run dg run hello-world --watch[/]"
         "\n\n[yellow]This is an instance for one person on one machine[/]: SQLite on this disk, and"