doploy-cli 0.2.1__tar.gz → 0.2.3__tar.gz

{doploy_cli-0.2.1 → doploy_cli-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: doploy-cli
-Version: 0.2.1
+Version: 0.2.3
 Summary: doploy CLI: watch builds, read logs, and drive Odoo deployments from a terminal
 License: MIT
 Project-URL: Homepage, https://doploy.io
@@ -55,6 +55,16 @@ uv tool install doploy-cli
 
 Requires Python 3.10 or newer.
 
+## Using it from a coding agent
+
+```bash
+doploy skill install
+```
+
+Installs a skill file so Claude Code knows when to use `doploy`, how to find ids, and the
+push → build → read failures → fix loop. `doploy skill print >> AGENTS.md` does the same for
+Codex and other agents.
+
 ## Sign in
 
 ```bash
@@ -83,9 +93,11 @@ doploy logs <build-id> --source test -f      # follow the test log until the bui
 | Command | Description |
 |---|---|
 | `login` | Sign in with your browser |
+| `skill install` | Teach Claude Code to use doploy (`skill print` for AGENTS.md) |
 | `logout` | Forget the saved session |
 | `projects` | List your projects |
-| `builds <project>` | Recent builds for a project. `--type development\|staging\|production`, `--limit` |
+| `builds <project>` | Live builds for a project. `--type development\|staging\|production`, `--limit`, `--all` |
+| `branches <project>` | Live branches with their ids |
 | `build <id>` | One build: status, commit, versions, error summary |
 | `tests <build>` | Test failures for a build. `--details` prints tracebacks, `--warnings` includes warnings |
 | `logs <build>` | Tail logs. `--source build\|test\|odoo`, `--lines`, `--filter TEXT`, `-f` to follow |

{doploy_cli-0.2.1 → doploy_cli-0.2.3}/README.md

@@ -33,6 +33,16 @@ uv tool install doploy-cli
 
 Requires Python 3.10 or newer.
 
+## Using it from a coding agent
+
+```bash
+doploy skill install
+```
+
+Installs a skill file so Claude Code knows when to use `doploy`, how to find ids, and the
+push → build → read failures → fix loop. `doploy skill print >> AGENTS.md` does the same for
+Codex and other agents.
+
 ## Sign in
 
 ```bash
@@ -61,9 +71,11 @@ doploy logs <build-id> --source test -f      # follow the test log until the bui
 | Command | Description |
 |---|---|
 | `login` | Sign in with your browser |
+| `skill install` | Teach Claude Code to use doploy (`skill print` for AGENTS.md) |
 | `logout` | Forget the saved session |
 | `projects` | List your projects |
-| `builds <project>` | Recent builds for a project. `--type development\|staging\|production`, `--limit` |
+| `builds <project>` | Live builds for a project. `--type development\|staging\|production`, `--limit`, `--all` |
+| `branches <project>` | Live branches with their ids |
 | `build <id>` | One build: status, commit, versions, error summary |
 | `tests <build>` | Test failures for a build. `--details` prints tracebacks, `--warnings` includes warnings |
 | `logs <build>` | Tail logs. `--source build\|test\|odoo`, `--lines`, `--filter TEXT`, `-f` to follow |

doploy_cli-0.2.3/doploy_cli/SKILL.md

@@ -0,0 +1,63 @@
+---
+name: doploy
+description: Use the `doploy` CLI to watch Odoo builds, read test failures and logs, and update modules on doploy-hosted deployments. Use when the repo is an Odoo project deployed on doploy, when a build or test run needs checking, or when the user asks to deploy, update modules, or look at logs.
+---
+
+# doploy
+
+`doploy` is the command line for doploy, which builds and hosts Odoo projects from a GitHub
+repo. Every branch push produces a development build with a full Odoo test run. Production and
+staging are long-lived deployments that update in place.
+
+Check it is installed and signed in with `doploy projects`. If that fails, tell the user to run
+`pipx install doploy-cli && doploy login` (it opens a browser; do not try to sign in for them).
+
+## Finding ids
+
+Ids are stable and worth reusing within a session.
+
+```bash
+doploy projects                       # project id (short string, e.g. Bx2Nx)
+doploy builds <project> --type development --limit 5    # build ids, newest first
+doploy branches <project>             # branch ids, for `branch create --from`
+```
+
+Prefer `--json` when you need to parse output.
+
+## The loop after pushing code
+
+1. Push the commit. doploy builds the branch automatically.
+2. `doploy builds <project> --type development --limit 3` until the newest build for your
+   commit leaves `Building`. Poll every 30 seconds or so; builds take several minutes.
+3. On `Error` or `Active Error`: `doploy tests <build> --details` shows every failing test with
+   its traceback. `doploy logs <build> --source test --filter ERROR` shows the surrounding log.
+4. Fix, push, repeat. On `Success`, open the pull request.
+
+Do not create a new build by hand for a branch you already pushed; the push did it.
+
+## Logs
+
+```bash
+doploy logs <build> --source test -f        # follow the test run until the build settles
+doploy logs <build> --source odoo --filter Traceback   # the running container (staging/prod)
+doploy logs <build> --source build           # doploy's own deploy log
+```
+
+## After a merge to staging or production
+
+Code updates land in place. The changed modules still need `odoo-bin -u`:
+
+```bash
+doploy update-modules <build> --wait        # exactly the modules doploy saw change
+```
+
+`--wait` exits non-zero if the update failed; print the tail it shows. Add `--theme` when a
+website theme changed and the user says so.
+
+## Rules
+
+- Anything aimed at production needs `--confirm`. Ask the user before adding it.
+- `doploy backup <build> --confirm --wait` before risky production updates.
+- The CLI cannot delete, restore, or change domains. Do not look for a way around that.
+- Deploy commands may return "Deploy actions are not enabled". The user turns that on in
+  doploy under Settings → Connected apps. Do not retry until they say it is done.

{doploy_cli-0.2.1 → doploy_cli-0.2.3}/doploy_cli/main.py

@@ -232,7 +232,7 @@ def cmd_login(args):
         _browser_login(base)
     projects = _client(argparse.Namespace(token=None, base=base)).request('GET', '/projects')
     print(f'logged in; {len(projects["projects"])} project(s) visible; config saved to {CONFIG_PATH}')
-    print('Deploy actions: toggle "Allow deploy actions" in Settings > MCP Connections.')
+    print('Deploy actions: toggle "Allow deploy actions" in Settings > Connected apps.')
 
 
 def cmd_logout(args):
@@ -240,7 +240,7 @@ def cmd_logout(args):
     for k in ('token', 'access_token', 'refresh_token', 'client_id', 'expires_at'):
         cfg.pop(k, None)
     _save_config(cfg)
-    print('logged out (revoke the grant in Settings > MCP Connections to kill the session server-side)')
+    print('logged out (revoke the grant in Settings > Connected apps to kill the session server-side)')
 
 
 def cmd_projects(args):
@@ -251,15 +251,39 @@ def cmd_projects(args):
     _table(data['projects'], ['id', 'name', 'odoo_version'])
 
 
+def _short(rows: list[dict]) -> list[dict]:
+    """Table-friendly copies: 7-char commit, minute-precision timestamps."""
+    out = []
+    for r in rows:
+        r = dict(r)
+        if r.get('commit_sha'):
+            r['commit'] = r['commit_sha'][:7]
+        if r.get('created'):
+            r['created'] = r['created'][:16].replace('T', ' ')
+        out.append(r)
+    return out
+
+
 def cmd_builds(args):
     params = {'limit': str(args.limit)}
     if args.type:
         params['type'] = args.type
+    if args.all:
+        params['all'] = '1'
     data = _client(args).request('GET', f'/projects/{args.project}/builds', params=params)
     if args.json:
         print(json.dumps(data, indent=2))
         return
-    _table(data['builds'], ['id', 'type', 'status', 'fqdn', 'commit_sha', 'created'])
+    _table(_short(data['builds']), ['id', 'type', 'status', 'fqdn', 'commit', 'created'])
+
+
+def cmd_branches(args):
+    params = {'all': '1'} if args.all else None
+    data = _client(args).request('GET', f'/projects/{args.project}/branches', params=params)
+    if args.json:
+        print(json.dumps(data, indent=2))
+        return
+    _table(data['branches'], ['id', 'name', 'type'])
 
 
 def cmd_build(args):
@@ -275,12 +299,20 @@ def cmd_tests(args):
     c = data['counts']
     print(f"build {data['build_id']} [{data['build_status']}] — "
           f"{c['error']} errors, {c['fail']} failures, {c['warning']} warnings")
+    loader_rows = 0
     for r in data['results']:
-        if r['error_type'] == 'WARNING' and not args.warnings:
+        if r['error_type'] not in ('ERROR', 'FAIL') and not args.warnings:
+            continue
+        is_test = bool(r.get('test')) and r['test'] != 'Unknown'
+        if not is_test and not args.details:
+            loader_rows += 1  # module-loading summaries: only interesting with --details
             continue
-        print(f"\n[{r['error_type']}] {r['module']}.{r['test']}")
+        where = f"{r['module']}.{r['test']}" if is_test else '(module loading)'
+        print(f"\n[{r['error_type']}] {where}")
         if args.details:
             print(r['details'])
+    if loader_rows:
+        print(f"\n(+{loader_rows} module-loading message(s); use --details to see them)")
 
 
 def cmd_rebuild(args):
@@ -329,15 +361,21 @@ def cmd_logs(args):
     if args.source == 'build':
         if data.get('error_summary'):
             print(f"error summary: {data['error_summary']}\n")
-        for t in data.get('tasks') or []:
-            print(f"task {t['id']} [{t['status']}] {t['title']}")
-        if data.get('tasks'):
-            print()
     shown = data['lines']
     for ln in shown:
         print(ln)
     if not args.follow:
-        if data.get('truncated'):
+        if args.filter:
+            searched = data.get('searched_lines')
+            total = data.get('total_lines')
+            if searched and total and total > searched:
+                scope = f"the last {searched} of {total} lines"
+            elif searched or total:
+                scope = f"all {total or searched} lines"
+            else:
+                scope = 'the recent log'
+            print(f"... ({len(shown)} matching line(s) in {scope})", file=sys.stderr)
+        elif data.get('truncated'):
             print(f"... (showing last {len(shown)} lines; use --lines to see more)", file=sys.stderr)
         return
     # Follow: poll and print only what is new. Build and test logs end when
@@ -443,6 +481,34 @@ def cmd_backup(args):
         sys.exit(1)
 
 
+# --- agent skill ------------------------------------------------------------
+#
+# The skill ships inside the package (doploy_cli/SKILL.md) so no public repo
+# is needed. `doploy skill install` drops it where Claude Code discovers it;
+# `doploy skill print` gives the same text for AGENTS.md / other agents.
+
+def _skill_text() -> str:
+    from importlib import resources
+    return resources.files('doploy_cli').joinpath('SKILL.md').read_text(encoding='utf-8')
+
+
+def _skill_target(project: bool) -> Path:
+    base = Path.cwd() if project else Path.home()
+    return base / '.claude' / 'skills' / 'doploy' / 'SKILL.md'
+
+
+def cmd_skill(args):
+    if args.skill_command == 'print':
+        print(_skill_text(), end='')
+        return
+    target = _skill_target(args.project)
+    target.parent.mkdir(parents=True, exist_ok=True)
+    target.write_text(_skill_text(), encoding='utf-8')
+    scope = 'this project' if args.project else 'all projects'
+    print(f'installed doploy skill for Claude Code ({scope}): {target}')
+    print('Other agents: `doploy skill print >> AGENTS.md`')
+
+
 def main(argv=None):
     p = argparse.ArgumentParser(prog='doploy', description=__doc__.splitlines()[0])
     p.add_argument('--token', help=argparse.SUPPRESS)
@@ -457,17 +523,33 @@ def main(argv=None):
     sp = sub.add_parser('logout', help='forget saved credentials')
     sp.set_defaults(func=cmd_logout)
 
+    sp = sub.add_parser('skill', help='teach coding agents how to use doploy')
+    ssub = sp.add_subparsers(dest='skill_command', required=True)
+    ip = ssub.add_parser('install', help='install the Claude Code skill (~/.claude/skills/doploy)')
+    ip.add_argument('--project', action='store_true',
+                    help='install into ./.claude/skills instead of your home directory')
+    ip.set_defaults(func=cmd_skill)
+    pp = ssub.add_parser('print', help='print the skill text, e.g. for AGENTS.md')
+    pp.set_defaults(func=cmd_skill)
+
     sp = sub.add_parser('projects', help='list your projects')
     sp.add_argument('--json', action='store_true')
     sp.set_defaults(func=cmd_projects)
 
-    sp = sub.add_parser('builds', help='list builds for a project')
+    sp = sub.add_parser('builds', help='list live builds for a project')
     sp.add_argument('project', help='project id (from `doploy projects`)')
     sp.add_argument('--type', choices=['development', 'staging', 'production'])
     sp.add_argument('--limit', type=int, default=20)
+    sp.add_argument('--all', action='store_true', help='include torn-down builds')
     sp.add_argument('--json', action='store_true')
     sp.set_defaults(func=cmd_builds)
 
+    sp = sub.add_parser('branches', help='list live branches for a project')
+    sp.add_argument('project', help='project id (from `doploy projects`)')
+    sp.add_argument('--all', action='store_true', help='include branches whose git ref is gone')
+    sp.add_argument('--json', action='store_true')
+    sp.set_defaults(func=cmd_branches)
+
     sp = sub.add_parser('build', help='show one build')
     sp.add_argument('build_id', type=int)
     sp.set_defaults(func=cmd_build)

{doploy_cli-0.2.1 → doploy_cli-0.2.3}/doploy_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: doploy-cli
-Version: 0.2.1
+Version: 0.2.3
 Summary: doploy CLI: watch builds, read logs, and drive Odoo deployments from a terminal
 License: MIT
 Project-URL: Homepage, https://doploy.io
@@ -55,6 +55,16 @@ uv tool install doploy-cli
 
 Requires Python 3.10 or newer.
 
+## Using it from a coding agent
+
+```bash
+doploy skill install
+```
+
+Installs a skill file so Claude Code knows when to use `doploy`, how to find ids, and the
+push → build → read failures → fix loop. `doploy skill print >> AGENTS.md` does the same for
+Codex and other agents.
+
 ## Sign in
 
 ```bash
@@ -83,9 +93,11 @@ doploy logs <build-id> --source test -f      # follow the test log until the bui
 | Command | Description |
 |---|---|
 | `login` | Sign in with your browser |
+| `skill install` | Teach Claude Code to use doploy (`skill print` for AGENTS.md) |
 | `logout` | Forget the saved session |
 | `projects` | List your projects |
-| `builds <project>` | Recent builds for a project. `--type development\|staging\|production`, `--limit` |
+| `builds <project>` | Live builds for a project. `--type development\|staging\|production`, `--limit`, `--all` |
+| `branches <project>` | Live branches with their ids |
 | `build <id>` | One build: status, commit, versions, error summary |
 | `tests <build>` | Test failures for a build. `--details` prints tracebacks, `--warnings` includes warnings |
 | `logs <build>` | Tail logs. `--source build\|test\|odoo`, `--lines`, `--filter TEXT`, `-f` to follow |

{doploy_cli-0.2.1 → doploy_cli-0.2.3}/doploy_cli.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 LICENSE
 README.md
 pyproject.toml
+doploy_cli/SKILL.md
 doploy_cli/__init__.py
 doploy_cli/main.py
 doploy_cli.egg-info/PKG-INFO

{doploy_cli-0.2.1 → doploy_cli-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "doploy-cli"
-version = "0.2.1"
+version = "0.2.3"
 description = "doploy CLI: watch builds, read logs, and drive Odoo deployments from a terminal"
 readme = "README.md"
 license = { text = "MIT" }
@@ -31,3 +31,6 @@ doploy = "doploy_cli.main:main"
 
 [tool.setuptools.packages.find]
 include = ["doploy_cli*"]
+
+[tool.setuptools.package-data]
+doploy_cli = ["SKILL.md"]