jama-cli 0.1.0__tar.gz

jama_cli-0.1.0/LICENSE

@@ -0,0 +1,55 @@
+MIT License
+
+Copyright (c) 2025 Christian Nennemann
+
+DISCLAIMER: This is an unofficial community project and is not associated with, 
+endorsed by, or affiliated with Jama Software in any way. This project is maintained 
+by community contributors and is not an official product of Jama Software.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+This project incorporates the following third-party open source software:
+
+1. aiohttp - MIT License - Copyright (c) 2013-2021 aio-libs collaboration
+   https://github.com/aio-libs/aiohttp/blob/master/LICENSE.txt
+
+2. py-jama-rest-client - MIT License - Copyright (c) 2017 Jarrod Wubbel
+   https://github.com/jamalshahverdiev/py-jama-rest-client/blob/master/LICENSE
+
+3. pydantic - MIT License - Copyright (c) 2017-present, Samuel Colvin and other contributors
+   https://github.com/pydantic/pydantic/blob/main/LICENSE
+
+4. loguru - MIT License - Copyright (c) 2017-present, Delgan
+   https://github.com/Delgan/loguru/blob/master/LICENSE
+
+5. typer - MIT License - Copyright (c) 2020 Sebastián Ramírez
+   https://github.com/tiangolo/typer/blob/master/LICENSE
+
+6. asyncio - PSF License - Copyright (c) Python Software Foundation
+   Part of the Python standard library
+
+7. jsonschema - MIT License - Copyright (c) 2013 Julian Berman
+   https://github.com/python-jsonschema/jsonschema/blob/main/COPYING
+
+8. python-dotenv - BSD 3-Clause License - Copyright (c) 2014, Saurabh Kumar
+   https://github.com/theskumar/python-dotenv/blob/master/LICENSE
+
+All third-party libraries used in this project are compatible with the MIT License.

jama_cli-0.1.0/NOTICE

@@ -0,0 +1,116 @@
+NOTICES AND INFORMATION
+Do Not Translate or Localize
+
+DISCLAIMER: This is an unofficial community project and is not associated with, endorsed by, or affiliated with Jama Software in any way.
+
+This software incorporates material from third parties. A list of these third-party components and their licenses follows.
+
+---------------------------------------------
+1. aiohttp (https://github.com/aio-libs/aiohttp)
+---------------------------------------------
+
+Copyright (c) 2013-2021 aio-libs collaboration
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------------
+2. py-jama-rest-client (https://github.com/jamalshahverdiev/py-jama-rest-client)
+---------------------------------------------
+
+MIT License
+
+Copyright (c) 2017 Jarrod Wubbel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------------
+3. pydantic (https://github.com/pydantic/pydantic)
+---------------------------------------------
+
+MIT License
+
+Copyright (c) 2017-present, Samuel Colvin and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------------
+4. loguru (https://github.com/Delgan/loguru)
+---------------------------------------------
+
+MIT License
+
+Copyright (c) 2017-present, Delgan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------------
+5. typer (https://github.com/tiangolo/typer)
+---------------------------------------------
+
+MIT License
+
+Copyright (c) 2020 Sebastián Ramírez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------------
+6. asyncio (Python standard library)
+---------------------------------------------
+
+Python Software Foundation License (PSF License)
+This is part of the Python standard library. For more information, see:
+https://docs.python.org/3/license.html
+
+---------------------------------------------
+7. jsonschema (https://github.com/python-jsonschema/jsonschema)
+---------------------------------------------
+
+MIT License
+
+Copyright (c) 2013 Julian Berman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---------------------------------------------
+8. python-dotenv (https://github.com/theskumar/python-dotenv)
+---------------------------------------------
+
+BSD 3-Clause License
+
+Copyright (c) 2014, Saurabh Kumar, Michael Schlottke-Lakemper
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

jama_cli-0.1.0/PKG-INFO

@@ -0,0 +1,526 @@
+Metadata-Version: 2.4
+Name: jama-cli
+Version: 0.1.0
+Summary: Command-line interface for Jama requirements management with MCP server support
+License: MIT
+License-File: LICENSE
+License-File: NOTICE
+Keywords: jama,cli,mcp,model-context-protocol,requirements-management,api
+Author: Christian Nennemann
+Author-email: 0lt7axgtr@mozmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: aiohttp (>=3.9.0,<4.0.0)
+Requires-Dist: aiohttp-swagger3 (>=0.8.0,<0.9.0)
+Requires-Dist: jsonschema (>=4.19.0,<5.0.0)
+Requires-Dist: loguru (>=0.7.0,<0.8.0)
+Requires-Dist: mcp (>=1.0.0,<2.0.0)
+Requires-Dist: py-jama-rest-client (>=1.17.0,<2.0.0)
+Requires-Dist: pydantic (>=2.0.0,<3.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: pyyaml (>=6.0.0,<7.0.0)
+Requires-Dist: rich (>=13.0.0,<14.0.0)
+Requires-Dist: typer[all] (>=0.12.0)
+Project-URL: Repository, https://github.com/XORwell/jama-cli
+Description-Content-Type: text/markdown
+
+# Jama CLI
+
+[![CI](https://github.com/XORwell/jama-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/XORwell/jama-cli/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/jama-cli.svg)](https://pypi.org/project/jama-cli/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/jama-cli.svg)](https://pypi.org/project/jama-cli/)
+[![Docker Image](https://img.shields.io/badge/ghcr.io-jama--cli-blue)](https://github.com/XORwell/jama-cli/pkgs/container/jama-cli)
+
+A powerful command-line interface for Jama requirements management, with MCP (Model Context Protocol) server support for AI assistants.
+
+> **DISCLAIMER**: This is an unofficial community project and is not associated with, endorsed by, or affiliated with Jama Software in any way.
+
+## Quick Start
+
+```bash
+# Install
+pip install jama-cli
+
+# Configure
+jama config init
+
+# Use
+jama projects list
+jama items list 123
+jama items get 456 --output json
+```
+
+## Features
+
+### CLI Commands
+- **Projects**: List, view, and search projects
+- **Items**: Full CRUD operations (create, read, update, delete)
+- **Relationships**: Manage upstream/downstream traceability
+- **Traceability**: Coverage analysis, trace matrix, trace trees
+- **Baselines**: Compare baselines, view versioned items
+- **History**: View item version history, compare versions
+- **Search**: Full-text and regex search across projects
+- **Diff**: Compare projects, count differences
+- **Migrate**: Export, import, clone, copy data
+- **Types**: View item types and their fields
+- **Config**: Multi-profile configuration management
+
+> **See [EXAMPLES.md](https://github.com/XORwell/jama-cli/blob/main/EXAMPLES.md) for comprehensive usage examples**
+
+### MCP Server
+- **stdio mode**: Native integration with Claude Desktop, Cline, VS Code
+- **HTTP mode**: REST API with OpenAPI documentation
+- **70 Jama operations**: Complete API coverage
+
+### Output Formats
+```bash
+jama items list 123                    # Table (default)
+jama items list 123 --output json      # JSON
+jama items list 123 --output csv       # CSV
+jama items list 123 --output yaml      # YAML
+```
+
+## Installation
+
+### pip (recommended)
+```bash
+pip install jama-cli
+```
+
+### pipx (isolated)
+```bash
+pipx install jama-cli
+```
+
+### From source
+```bash
+git clone https://github.com/XORwell/jama-cli.git
+cd jama-cli
+pip install -e .
+```
+
+## Configuration
+
+### Interactive Setup
+```bash
+jama config init
+```
+
+### Configuration File
+Location: `~/.jama/config.yml`
+
+```yaml
+default_profile: production
+
+profiles:
+  production:
+    url: https://company.jamacloud.com
+    auth_type: api_key
+    api_key: ${JAMA_API_KEY}  # Environment variable
+
+  staging:
+    url: https://staging.jamacloud.com
+    auth_type: oauth
+    client_id: ${JAMA_CLIENT_ID}
+    client_secret: ${JAMA_CLIENT_SECRET}
+
+defaults:
+  output: table
+  limit: 50
+```
+
+### Environment Variables
+```bash
+export JAMA_URL=https://company.jamacloud.com
+export JAMA_API_KEY=your-api-key
+export JAMA_PROFILE=production  # Optional: override default profile
+```
+
+## CLI Commands
+
+### Projects
+```bash
+jama projects list                     # List all projects
+jama projects get 123                  # Get project details
+jama projects list --output json       # JSON output
+```
+
+### Items
+```bash
+jama items list 123                    # List items in project 123
+jama items get 456                     # Get item details
+jama items children 456                # Get child items
+
+# Create item
+jama items create 123 --type 45 --name "New Requirement"
+
+# Update item
+jama items update 456 --name "Updated Name"
+jama items update 456 --field status=Approved
+
+# Delete item
+jama items delete 456
+jama items delete 456 --force          # Skip confirmation
+```
+
+### Relationships
+```bash
+jama relationships list 456            # All relationships for item
+jama relationships upstream 456        # Upstream items (traced from)
+jama relationships downstream 456      # Downstream items (traced to)
+
+# Create relationship
+jama relationships create --from 456 --to 789
+
+# Delete relationship  
+jama relationships delete 123
+```
+
+### Item Types
+```bash
+jama types list                        # List all item types
+jama types get 45                      # Get type details
+```
+
+### Configuration
+```bash
+jama config init                       # Interactive setup
+jama config list                       # List profiles
+jama config show                       # Show current profile
+jama config add prod --url https://... --api-key xxx
+jama config remove staging
+jama config set-default production
+jama config cache                      # Show cache stats
+jama config cache --clear              # Clear cache
+```
+
+### Search
+```bash
+jama search items "login"                        # Search all projects
+jama search items "login" --project 123          # Search in specific project
+jama search items "REQ-" --field documentKey     # Search by document key
+jama search items "^REQ-\\d+" --regex            # Regex search
+jama search items "test" --type 45               # Search specific item type
+jama search fields 123                           # List searchable fields
+```
+
+### Diff (Compare Projects)
+```bash
+jama diff projects 123 456                       # Compare two projects
+jama diff projects 123 456 --from dev --to prod  # Compare across instances
+jama diff projects 123 456 --type 45             # Compare specific item type
+jama diff projects 123 456 --key name            # Match by name instead of key
+jama diff count 123 456                          # Quick count comparison
+```
+
+### Traceability Analysis
+```bash
+jama trace matrix 1172                           # Traceability matrix
+jama trace matrix 1172 -s 45 -t 67               # Requirements → Test Cases
+jama trace matrix 1172 --untraced                # Show coverage gaps
+jama trace coverage 1172                         # Coverage % by item type
+jama trace tree 12345                            # Trace tree for item
+jama trace tree 12345 --direction upstream       # Upstream only
+```
+
+### Baselines
+```bash
+jama baseline list 1172                          # List baselines
+jama baseline items 100                          # Items in baseline
+jama baseline diff 100 101                       # Compare baselines
+# Shows: +Added, ~Modified, -Removed
+```
+
+### Version History
+```bash
+jama history list 12345                          # Version history
+jama history get 12345 3                         # Get version 3
+jama history diff 12345 1 3                      # Compare versions
+```
+
+### Data Migration
+```bash
+# Export items to JSON (fast by default)
+jama migrate export 123                          # Export all items
+jama migrate export 123 --max 100                # Export first 100 items (fast)
+jama migrate export 123 --parent 456 --max 50   # Export subtree, limit 50
+jama migrate export 123 --type 45                # Export only type 45
+jama migrate export 123 --relationships          # Include relationships (slower)
+
+# Import from JSON
+jama migrate import backup.json --project 456   # Import to project 456
+jama migrate import backup.json -p 456 --dry-run  # Preview import
+
+# Clone within same instance
+jama migrate clone 123 456                       # Clone project 123 to 456
+jama migrate clone 123 456 --source-parent 789   # Clone children of item
+
+# Copy between instances (requires two profiles)
+jama migrate copy 123 456 --from staging --to production
+
+# Inspect export file
+jama migrate info backup.json
+```
+
+## MCP Server
+
+### For Claude Desktop / Cline
+
+Add to your MCP configuration:
+
+```json
+{
+  "mcpServers": {
+    "jama": {
+      "command": "jama",
+      "args": ["serve", "--stdio"]
+    }
+  }
+}
+```
+
+### HTTP Server
+
+```bash
+# Start HTTP server
+jama serve                             # Default: localhost:8000
+jama serve --port 9000                 # Custom port
+jama serve --api-key secret            # With authentication
+
+# Access
+curl http://localhost:8000/health
+open http://localhost:8000/api/docs    # Swagger UI
+```
+
+### Available Operations
+
+The MCP server exposes 70 Jama API operations:
+
+| Category | Operations |
+|----------|------------|
+| Projects | get_projects, get_project |
+| Items | get_items, get_item, create_item, update_item, delete_item |
+| Relationships | get_relationships, create_relationship, delete_relationship |
+| Types | get_item_types, get_item_type |
+| Pick Lists | get_pick_lists, get_pick_list, get_pick_list_options |
+| Tags | get_tags, get_tagged_items |
+| Tests | get_test_plans, get_test_cycles, get_test_runs |
+| Attachments | get_attachments, upload_attachment |
+| ... | See full list in API documentation |
+
+## Global Options
+
+```bash
+jama [OPTIONS] COMMAND [ARGS]
+
+Options:
+  -p, --profile TEXT     Profile name from config
+  -o, --output FORMAT    Output: table, json, csv, yaml
+  -v, --verbose          Increase verbosity (-v, -vv, -vvv)
+  -q, --quiet            Suppress non-error output
+  --version              Show version
+  --help                 Show help
+```
+
+## Examples
+
+### List requirements and export to CSV
+```bash
+jama items list 123 --type 45 --output csv > requirements.csv
+```
+
+### Get item as JSON for scripting
+```bash
+ITEM=$(jama items get 456 --output json)
+echo $ITEM | jq '.fields.name'
+```
+
+### Create item from script
+```bash
+jama items create 123 \
+  --type 45 \
+  --name "REQ-001: User Authentication" \
+  --description "Users shall authenticate with SSO" \
+  --field priority=High \
+  --field status=Draft
+```
+
+### Trace upstream requirements
+```bash
+jama relationships upstream 456 --output table
+```
+
+### Use different profile
+```bash
+jama -p staging items list 123
+```
+
+## Docker
+
+A pre-built Docker image is available for running the Jama MCP server without installing Python.
+
+```bash
+docker pull ghcr.io/xorwell/jama-cli
+```
+
+### Quick Start
+
+```bash
+# Using environment variables
+docker run -p 8000:8000 \
+  -e JAMA_URL=https://company.jamacloud.com \
+  -e JAMA_API_KEY=your-api-key \
+  ghcr.io/xorwell/jama-cli
+```
+
+The server starts on port 8000 with health checks, rate limiting, and Swagger UI at `/api/docs`.
+
+### Using a Config File
+
+Mount your existing `~/.jama/config.yml` into the container:
+
+```bash
+docker run -p 8000:8000 \
+  -v ~/.jama/config.yml:/home/appuser/.jama/config.yml:ro \
+  ghcr.io/xorwell/jama-cli
+```
+
+To use a specific profile from your config:
+
+```bash
+docker run -p 8000:8000 \
+  -v ~/.jama/config.yml:/home/appuser/.jama/config.yml:ro \
+  ghcr.io/xorwell/jama-cli \
+  jama serve --host 0.0.0.0 --port 8000 --profile production
+```
+
+### Authentication Methods
+
+```bash
+# API Key
+docker run -p 8000:8000 \
+  -e JAMA_URL=https://company.jamacloud.com \
+  -e JAMA_API_KEY=your-api-key \
+  ghcr.io/xorwell/jama-cli
+
+# OAuth2 Client Credentials
+docker run -p 8000:8000 \
+  -e JAMA_URL=https://company.jamacloud.com \
+  -e JAMA_CLIENT_ID=your-client-id \
+  -e JAMA_CLIENT_SECRET=your-client-secret \
+  ghcr.io/xorwell/jama-cli
+
+# Username/Password
+docker run -p 8000:8000 \
+  -e JAMA_URL=https://company.jamacloud.com \
+  -e JAMA_USERNAME=your-username \
+  -e JAMA_PASSWORD=your-password \
+  ghcr.io/xorwell/jama-cli
+```
+
+### Server Authentication
+
+Protect the MCP server with an API key so only authorized clients can use it:
+
+```bash
+docker run -p 8000:8000 \
+  -e JAMA_URL=https://company.jamacloud.com \
+  -e JAMA_API_KEY=your-jama-key \
+  -e MCP_API_KEY=my-server-secret \
+  ghcr.io/xorwell/jama-cli
+
+# Clients must include: Authorization: Bearer my-server-secret
+```
+
+### Docker Compose
+
+```yaml
+services:
+  jama-mcp:
+    image: ghcr.io/xorwell/jama-cli
+    ports:
+      - "8000:8000"
+    environment:
+      - JAMA_URL=https://company.jamacloud.com
+      - JAMA_API_KEY=${JAMA_API_KEY}
+    # Or mount config:
+    # volumes:
+    #   - ~/.jama/config.yml:/home/appuser/.jama/config.yml:ro
+    restart: unless-stopped
+```
+
+### Using the CLI via Docker
+
+You can also use the Docker image to run CLI commands:
+
+```bash
+docker run --rm \
+  -e JAMA_URL=https://company.jamacloud.com \
+  -e JAMA_API_KEY=your-api-key \
+  ghcr.io/xorwell/jama-cli \
+  jama projects list
+
+docker run --rm \
+  -e JAMA_URL=https://company.jamacloud.com \
+  -e JAMA_API_KEY=your-api-key \
+  ghcr.io/xorwell/jama-cli \
+  jama items list 123 --output json
+```
+
+### Building Locally
+
+```bash
+docker build -t jama-cli .
+docker run -p 8000:8000 -e JAMA_URL=... -e JAMA_API_KEY=... jama-cli
+```
+
+> **See [DOCKER.md](https://github.com/XORwell/jama-cli/blob/main/DOCKER.md) for full Docker documentation** including endpoints, image details, Kubernetes probes, and more.
+
+## Development
+
+```bash
+# Clone
+git clone https://github.com/XORwell/jama-cli.git
+cd jama-cli
+
+# Install with dev dependencies
+poetry install
+
+# Run tests
+poetry run pytest
+
+# Lint
+poetry run ruff check .
+poetry run black --check .
+
+# Type check
+poetry run mypy jama_cli jama_mcp_server
+```
+
+## License
+
+MIT License - see [LICENSE](https://github.com/XORwell/jama-cli/blob/main/LICENSE)
+
+## Contributing
+
+Contributions welcome! Please read [CONTRIBUTING.md](https://github.com/XORwell/jama-cli/blob/main/CONTRIBUTING.md).
+
+## Related
+
+- [Jama REST API Documentation](https://dev.jamasoftware.com/api/)
+- [Model Context Protocol](https://modelcontextprotocol.io/)
+- [py-jama-rest-client](https://github.com/jamasoftware-ps/py-jama-rest-client)
+