atlassian-cli 0.10.4__tar.gz → 0.11.0__tar.gz

{atlassian_cli-0.10.4/src/atlassian_cli.egg-info → atlassian_cli-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atlassian-cli
-Version: 0.10.4
+Version: 0.11.0
 Summary: Fast CLI tools for Atlassian Cloud (Confluence + Jira) — optimized for AI agents
 Author-email: Alex Fishlock <alex.fishlock@catapult.cx>
 License-Expression: MIT
@@ -104,9 +104,19 @@ confluence diff 9268920323
 confluence sync POL
 confluence sync COMPLY --workers 20 --force
 
-# Search local page index (instant, no API call)
+# Bulk-render pages as markdown (instead of ADF JSON) — handy for AI ingestion
+confluence sync POL --md                   # writes pages/POL/<id>.md
+confluence get 9268920323 --md             # single page, as markdown
+
+# Search local page index by title (instant, no API call)
 confluence search "risk assessment"
 
+# Content-level search via Confluence's CQL (hits the live API)
+confluence cql 'text ~ "risk register"'
+confluence cql 'text ~ "risk"' --space POL --limit 10
+confluence cql 'text ~ "risk"' --md        # markdown bullet list with deep links
+confluence --json cql 'text ~ "risk"'      # JSON array
+
 # Rebuild the page index
 confluence index
 confluence index --space POL --space COMPLY

{atlassian_cli-0.10.4 → atlassian_cli-0.11.0}/README.md

@@ -73,9 +73,19 @@ confluence diff 9268920323
 confluence sync POL
 confluence sync COMPLY --workers 20 --force
 
-# Search local page index (instant, no API call)
+# Bulk-render pages as markdown (instead of ADF JSON) — handy for AI ingestion
+confluence sync POL --md                   # writes pages/POL/<id>.md
+confluence get 9268920323 --md             # single page, as markdown
+
+# Search local page index by title (instant, no API call)
 confluence search "risk assessment"
 
+# Content-level search via Confluence's CQL (hits the live API)
+confluence cql 'text ~ "risk register"'
+confluence cql 'text ~ "risk"' --space POL --limit 10
+confluence cql 'text ~ "risk"' --md        # markdown bullet list with deep links
+confluence --json cql 'text ~ "risk"'      # JSON array
+
 # Rebuild the page index
 confluence index
 confluence index --space POL --space COMPLY

{atlassian_cli-0.10.4 → atlassian_cli-0.11.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "atlassian-cli"
-version = "0.10.4"
+version = "0.11.0"
 description = "Fast CLI tools for Atlassian Cloud (Confluence + Jira) — optimized for AI agents"
 readme = "README.md"
 license = "MIT"

{atlassian_cli-0.10.4 → atlassian_cli-0.11.0}/src/atlassian_cli/confluence.py

@@ -251,15 +251,29 @@ def _ver_ts(page):
     return v.get('createdAt', '') if isinstance(v, dict) else ''
 
 
-def save_page(page_data, space_key, pages_dir):
+def save_page(page_data, space_key, pages_dir, *, output_format='adf'):
+    """Save a fetched page to ``pages_dir/<SPACE>/``.
+
+    output_format:
+      - 'adf' (default): write <id>.json containing the ADF body.
+      - 'md':            write <id>.md containing the markdown rendering.
+    The <id>.meta.json sidecar is always written.
+    """
     page_id = page_data['id']
     space_dir = os.path.join(pages_dir, space_key)
     os.makedirs(space_dir, exist_ok=True)
 
     body = page_data.get('body', {}).get('atlas_doc_format', {}).get('value', {})
-    adf_path = os.path.join(space_dir, f'{page_id}.json')
-    with open(adf_path, 'w') as f:
-        json.dump(body, f, indent=2)
+
+    if output_format == 'md':
+        from atlassian_cli.adf import adf_to_markdown
+        body_path = os.path.join(space_dir, f'{page_id}.md')
+        with open(body_path, 'w') as f:
+            f.write(adf_to_markdown(body))
+    else:
+        body_path = os.path.join(space_dir, f'{page_id}.json')
+        with open(body_path, 'w') as f:
+            json.dump(body, f, indent=2)
 
     meta = {
         'id': page_id,
@@ -274,7 +288,7 @@ def save_page(page_data, space_key, pages_dir):
     with open(meta_path, 'w') as f:
         json.dump(meta, f, indent=2)
 
-    return adf_path, meta_path
+    return body_path, meta_path
 
 
 def _find_page_file(page_id, pages_dir, suffix):
@@ -312,8 +326,9 @@ def cmd_get(args):
     page = get_page(session, base, args.page_id)
     space = get_space(session, base, space_id=page['spaceId'])
     space_key = space.get('key', str(page['spaceId']))
-    adf_path, _ = save_page(page, space_key, args.dir)
-    emit('OK', f'{page["title"]} (v{_ver(page)}) -> {adf_path}')
+    output_format = 'md' if getattr(args, 'md', False) else 'adf'
+    body_path, _ = save_page(page, space_key, args.dir, output_format=output_format)
+    emit('OK', f'{page["title"]} (v{_ver(page)}) -> {body_path}')
 
 
 def cmd_create(args):
@@ -709,12 +724,14 @@ def cmd_sync(args):
 
     to_fetch = []
     skipped = 0
+    body_suffix = '.md' if getattr(args, 'md', False) else '.json'
     for page in pages:
         page_id = page['id']
         remote_ver = _ver(page)
         if not args.force:
             meta = load_meta(page_id, args.dir)
-            if meta and meta.get('version', 0) >= remote_ver:
+            body_file = os.path.join(args.dir, space_key, f'{page_id}{body_suffix}')
+            if meta and meta.get('version', 0) >= remote_ver and os.path.isfile(body_file):
                 skipped += 1
                 continue
         to_fetch.append(page)
@@ -729,13 +746,14 @@ def cmd_sync(args):
     print(f'Fetching {len(to_fetch)} pages ({args.workers} workers)…', file=sys.stderr)
 
     errors = 0
+    output_format = 'md' if getattr(args, 'md', False) else 'adf'
 
     def fetch_one(page):
         nonlocal errors
         page_id = page['id']
         try:
             full_page = get_page(session, base, page_id)
-            save_page(full_page, space_key, args.dir)
+            save_page(full_page, space_key, args.dir, output_format=output_format)
             return f'GET {page_id} {full_page.get("title", "")} (v{_ver(full_page)})'
         except Exception as e:
             errors += 1
@@ -749,6 +767,57 @@ def cmd_sync(args):
     emit('DONE', f'{space_key}: {len(to_fetch)} fetched, {skipped} skipped, {errors} errors')
 
 
+def cmd_cql(args):
+    """Run a CQL query against the Confluence Search API.
+
+    Output modes:
+      - default: plain-text table (id [space] title)
+      - global --json: JSON array of {id, title, space, url, excerpt}
+      - --md: markdown bullet list with deep links
+    """
+    session, base = setup()
+    query = args.query
+    if args.space:
+        query = f'space = "{args.space}" AND ({query})'
+    data = api_get(session, base, f'{V1}/search', cql=query, limit=args.limit)
+    raw = data.get('results', [])
+
+    results = []
+    for r in raw:
+        content = r.get('content') or {}
+        space_key = ''
+        if isinstance(content.get('space'), dict):
+            space_key = content['space'].get('key', '')
+        results.append({
+            'id': content.get('id', ''),
+            'title': r.get('title') or content.get('title', ''),
+            'space': space_key,
+            'url': r.get('url', ''),
+            'excerpt': r.get('excerpt', ''),
+        })
+
+    if getattr(args, 'md', False):
+        if not results:
+            print('No results.', file=sys.stderr)
+        else:
+            for r in results:
+                title = r['title'] or '(untitled)'
+                space = r['space'] or '?'
+                page_id = r['id']
+                print(f'- [{title}]({r["url"]}) — {space} ({page_id})')
+        return
+
+    if is_json_mode():
+        print(json.dumps(results, indent=2))
+        return
+
+    if not results:
+        print('No results.', file=sys.stderr)
+        return
+    for r in results:
+        print(f'{r["id"]} [{r["space"] or "?"}] {r["title"]}')
+
+
 def cmd_search(args):
     if not os.path.isfile(args.index):
         emit_error(f'Index not found: {args.index}')
@@ -1297,6 +1366,7 @@ def main():
     p = sub.add_parser('get', help='Download a page (ADF + metadata)')
     p.add_argument('page_id', help='Confluence page ID')
     p.add_argument('--dir', default='pages', help='Output directory (default: pages)')
+    p.add_argument('--md', action='store_true', help='Save as markdown (<id>.md) instead of ADF JSON')
     p.set_defaults(func=cmd_get)
 
     p = sub.add_parser('create', help='Create a new page')
@@ -1389,8 +1459,16 @@ def main():
     p.add_argument('--dir', default='pages', help='Output directory (default: pages)')
     p.add_argument('--workers', type=int, default=10, help='Parallel workers (default: 10)')
     p.add_argument('--force', action='store_true', help='Re-download all, ignore cache')
+    p.add_argument('--md', action='store_true', help='Render each page as markdown (<id>.md) instead of ADF JSON')
     p.set_defaults(func=cmd_sync)
 
+    p = sub.add_parser('cql', help='Content-level search using CQL (Confluence Query Language)')
+    p.add_argument('query', help='CQL query string, e.g. \'text ~ "risk register"\'')
+    p.add_argument('--space', help='Restrict to a space (prepends space = "<KEY>" AND ... to the query)')
+    p.add_argument('--limit', type=int, default=25, help='Max results (default: 25)')
+    p.add_argument('--md', action='store_true', help='Markdown bullet-list output instead of plain text')
+    p.set_defaults(func=cmd_cql)
+
     p = sub.add_parser('search', help='Search local page index')
     p.add_argument('query', help='Search term (title or ID)')
     p.add_argument('--index', default='page-index.json', help='Index file path')

{atlassian_cli-0.10.4 → atlassian_cli-0.11.0/src/atlassian_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atlassian-cli
-Version: 0.10.4
+Version: 0.11.0
 Summary: Fast CLI tools for Atlassian Cloud (Confluence + Jira) — optimized for AI agents
 Author-email: Alex Fishlock <alex.fishlock@catapult.cx>
 License-Expression: MIT
@@ -104,9 +104,19 @@ confluence diff 9268920323
 confluence sync POL
 confluence sync COMPLY --workers 20 --force
 
-# Search local page index (instant, no API call)
+# Bulk-render pages as markdown (instead of ADF JSON) — handy for AI ingestion
+confluence sync POL --md                   # writes pages/POL/<id>.md
+confluence get 9268920323 --md             # single page, as markdown
+
+# Search local page index by title (instant, no API call)
 confluence search "risk assessment"
 
+# Content-level search via Confluence's CQL (hits the live API)
+confluence cql 'text ~ "risk register"'
+confluence cql 'text ~ "risk"' --space POL --limit 10
+confluence cql 'text ~ "risk"' --md        # markdown bullet list with deep links
+confluence --json cql 'text ~ "risk"'      # JSON array
+
 # Rebuild the page index
 confluence index
 confluence index --space POL --space COMPLY

{atlassian_cli-0.10.4 → atlassian_cli-0.11.0}/tests/test_confluence.py

@@ -17,10 +17,12 @@ from atlassian_cli.confluence import (
     cmd_blog_get,
     cmd_blog_list,
     cmd_blog_update,
+    cmd_cql,
     cmd_diff,
     cmd_get,
     cmd_index,
     cmd_search,
+    cmd_sync,
     create_blogpost,
     get_blogpost,
     get_page,
@@ -39,6 +41,7 @@ from atlassian_cli.confluence import (
 from atlassian_cli.output import set_json_mode
 
 BASE = "https://test.atlassian.net"
+V1 = "/wiki/rest/api"
 V2 = "/wiki/api/v2"
 
 SAMPLE_PAGE = {
@@ -165,6 +168,19 @@ class TestSavePage:
         assert meta["title"] == "Test Page"
         assert meta["version"] == 3
 
+    def test_md_format_writes_md_only(self, tmp_path):
+        body_path, meta_path = save_page(SAMPLE_PAGE, "TEST", str(tmp_path), output_format="md")
+        assert body_path.endswith(".md")
+        assert os.path.isfile(body_path)
+        assert os.path.isfile(meta_path)
+
+        with open(body_path) as f:
+            md = f.read()
+        assert "Hello" in md
+
+        # No ADF JSON file when --md
+        assert not os.path.isfile(os.path.join(str(tmp_path), "TEST", "12345.json"))
+
 
 class TestLoadMeta:
     def test_loads_existing(self, tmp_path):
@@ -194,11 +210,22 @@ class TestCmdGet:
             responses.GET, f"{BASE}{V2}/spaces/100",
             json=SAMPLE_SPACE,
         )
-        cmd_get(Namespace(page_id="12345", dir=str(tmp_path)))
+        cmd_get(Namespace(page_id="12345", dir=str(tmp_path), md=False))
         out = capsys.readouterr().out
         assert "Test Page" in out
         assert os.path.isfile(os.path.join(str(tmp_path), "TEST", "12345.json"))
 
+    @responses.activate
+    def test_downloads_page_as_md(self, capsys, tmp_path):
+        responses.add(responses.GET, f"{BASE}{V2}/pages/12345", json=SAMPLE_PAGE)
+        responses.add(
+            responses.GET, f"{BASE}{V2}/spaces/100",
+            json=SAMPLE_SPACE,
+        )
+        cmd_get(Namespace(page_id="12345", dir=str(tmp_path), md=True))
+        assert os.path.isfile(os.path.join(str(tmp_path), "TEST", "12345.md"))
+        assert not os.path.isfile(os.path.join(str(tmp_path), "TEST", "12345.json"))
+
 
 class TestCmdDiff:
     @responses.activate
@@ -589,3 +616,130 @@ class TestUpdateBlogpost:
                                      title="New Title", body="New body")
         assert title == "New Title"
         assert ver == 2
+
+
+class TestCmdSync:
+    @responses.activate
+    def test_renders_pages_as_md(self, capsys, tmp_path):
+        # Space lookup
+        responses.add(
+            responses.GET, f"{BASE}{V2}/spaces",
+            json={"results": [SAMPLE_SPACE]},
+        )
+        # Page list
+        responses.add(
+            responses.GET, f"{BASE}{V2}/spaces/100/pages",
+            json={"results": [{"id": "12345", "version": {"number": 3}}], "_links": {}},
+        )
+        # Page fetch
+        responses.add(responses.GET, f"{BASE}{V2}/pages/12345", json=SAMPLE_PAGE)
+
+        cmd_sync(Namespace(
+            space_key="TEST",
+            dir=str(tmp_path),
+            workers=1,
+            force=True,
+            md=True,
+        ))
+
+        assert os.path.isfile(os.path.join(str(tmp_path), "TEST", "12345.md"))
+        assert not os.path.isfile(os.path.join(str(tmp_path), "TEST", "12345.json"))
+
+
+SAMPLE_CQL_RESPONSE = {
+    "results": [
+        {
+            "content": {
+                "id": "12345",
+                "type": "page",
+                "title": "Risk Policy",
+                "space": {"key": "POL"},
+            },
+            "title": "Risk Policy",
+            "url": "/spaces/POL/pages/12345",
+            "excerpt": "Risks are managed via …",
+        },
+        {
+            "content": {
+                "id": "67890",
+                "type": "page",
+                "title": "Risk Register",
+                "space": {"key": "COMPLY"},
+            },
+            "title": "Risk Register",
+            "url": "/spaces/COMPLY/pages/67890",
+            "excerpt": "Open risks: …",
+        },
+    ],
+    "totalSize": 2,
+}
+
+
+class TestCmdCql:
+    @responses.activate
+    def test_text_output(self, capsys):
+        responses.add(
+            responses.GET, f"{BASE}{V1}/search",
+            json=SAMPLE_CQL_RESPONSE,
+        )
+        cmd_cql(Namespace(query='text ~ "risk"', space=None, limit=25, md=False))
+        out = capsys.readouterr().out
+        assert "Risk Policy" in out
+        assert "12345" in out
+        assert "POL" in out
+
+    @responses.activate
+    def test_json_output(self, capsys):
+        from atlassian_cli.output import set_json_mode
+        responses.add(
+            responses.GET, f"{BASE}{V1}/search",
+            json=SAMPLE_CQL_RESPONSE,
+        )
+        set_json_mode(True)
+        try:
+            cmd_cql(Namespace(query='text ~ "risk"', space=None, limit=25, md=False))
+        finally:
+            set_json_mode(False)
+        out = capsys.readouterr().out
+        parsed = json.loads(out)
+        assert isinstance(parsed, list)
+        assert parsed[0]["id"] == "12345"
+        assert parsed[0]["space"] == "POL"
+        assert parsed[0]["title"] == "Risk Policy"
+
+    @responses.activate
+    def test_md_output(self, capsys):
+        responses.add(
+            responses.GET, f"{BASE}{V1}/search",
+            json=SAMPLE_CQL_RESPONSE,
+        )
+        cmd_cql(Namespace(query='text ~ "risk"', space=None, limit=25, md=True))
+        out = capsys.readouterr().out
+        assert "Risk Policy" in out
+        assert "- " in out
+        assert "12345" in out
+
+    @responses.activate
+    def test_space_filter_prepends_clause(self):
+        captured = {}
+
+        def callback(request):
+            captured["url"] = request.url
+            return (200, {}, json.dumps(SAMPLE_CQL_RESPONSE))
+
+        responses.add_callback(
+            responses.GET, f"{BASE}{V1}/search", callback=callback,
+        )
+        cmd_cql(Namespace(query='text ~ "risk"', space="POL", limit=25, md=False))
+        # The space clause should be present in the URL-encoded CQL
+        assert 'space+%3D+%22POL%22' in captured["url"] or 'space%3D%22POL%22' in captured["url"]
+
+    @responses.activate
+    def test_no_results(self, capsys):
+        responses.add(
+            responses.GET, f"{BASE}{V1}/search",
+            json={"results": [], "totalSize": 0},
+        )
+        cmd_cql(Namespace(query='text ~ "nothing"', space=None, limit=25, md=False))
+        err = capsys.readouterr().err
+        assert "No results" in err