@codemieai/code 0.2.0 → 0.2.1

package/dist/agents/plugins/claude/plugin/skills/codemie-sdk/examples/datasources.md

@@ -0,0 +1,401 @@
+# Datasources Examples
+
+> **Important:** `create` and `update` require a **type subcommand**: `confluence`, `jira`, `file`, `code`, `google`, `azure-devops-wiki`, `azure-devops-work-item`, `xray`, `sharepoint`, `platform`
+>
+> **Name constraint:** must match `^[a-zA-Z0-9][\w-]*$` — no spaces, use hyphens (e.g. `my-wiki`, not `My Wiki`)
+
+## List
+
+```bash
+# Basic list
+codemie sdk datasources list
+
+# Filter
+codemie sdk datasources list --search 'Wiki' --projects Documentation
+codemie sdk datasources list --status completed
+codemie sdk datasources list --datasource-types confluence,jira
+codemie sdk datasources list --sort-key update_date --sort-order desc --json
+```
+
+**Status values:** `completed`, `failed`, `fetching`, `in_progress`
+
+**List columns:** ID, Name, Project, Type, Status
+
+## Get
+
+```bash
+codemie sdk datasources get ebfe842a-07af-4a8e-8790-7213834068e9
+codemie sdk datasources get ebfe842a-07af-4a8e-8790-7213834068e9 --json
+```
+
+## Create
+
+**Base fields (all types):**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `name` | ✅ | Must match `^[a-zA-Z0-9][\w-]*$` — no spaces, use hyphens |
+| `project_name` | ✅ | Project to create the datasource in |
+| `description` | — | Human-readable description of this datasource |
+| `shared_with_project` | — | `true` = visible to all project members |
+| `setting_id` | — | Integration ID to authenticate fetching — get IDs: `codemie sdk integrations list --json` |
+
+### Confluence
+
+> Requires a **Confluence integration** already configured in the project.
+> Get the integration ID: `codemie sdk integrations list --setting-type project --json | jq -r '.[] | select(.credential_type=="Confluence") | "\(.id) \(.alias)"'`
+
+```bash
+codemie sdk datasources create confluence --data '{
+  "name": "company-wiki",
+  "project_name": "Documentation",
+  "cql": "space=TEAM AND type=page",
+  "description": "Company-wide wiki",
+  "shared_with_project": true
+}'
+```
+
+**Confluence-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `cql` | ✅ | Confluence Query Language — e.g. `space=TEAM`, `space=TEAM AND type=page` |
+| `include_restricted_content` | — | Include pages that are restricted but accessible by the integration user |
+| `include_archived_content` | — | Include archived/historic pages |
+| `include_attachments` | — | Include file attachments from pages |
+| `include_comments` | — | Include page comments in indexed content |
+| `keep_markdown_format` | — | Preserve Markdown formatting in fetched content |
+| `keep_newlines` | — | Preserve newlines (prevents content collapsing) |
+| `max_pages` | — | Maximum number of pages to fetch (caps the index size) |
+| `pages_per_request` | — | Batch size per API call — tune lower to avoid Confluence rate limits |
+
+**Full Confluence example:**
+```json
+{
+  "name": "engineering-wiki",
+  "project_name": "Engineering",
+  "cql": "space=ENG AND type=page AND ancestor=12345",
+  "description": "Engineering team wiki pages",
+  "shared_with_project": true,
+  "include_attachments": false,
+  "include_comments": false,
+  "keep_markdown_format": true,
+  "max_pages": 500,
+  "pages_per_request": 25
+}
+```
+
+### Jira
+
+> Requires a **Jira integration** already configured in the project.
+> Get the integration ID: `codemie sdk integrations list --setting-type project --json | jq -r '.[] | select(.credential_type=="Jira") | "\(.id) \(.alias)"'`
+
+```bash
+codemie sdk datasources create jira --data '{
+  "name": "support-tickets",
+  "project_name": "Support",
+  "jql": "project=SUP AND status != Done",
+  "description": "Open support tickets",
+  "shared_with_project": true
+}'
+```
+
+**Jira-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `jql` | ✅ | Jira Query Language — e.g. `project=SUP AND status=Open ORDER BY created DESC` |
+
+### File (local files)
+
+```bash
+# One or more files (max 10), plus metadata
+codemie sdk datasources create file --file ./doc1.pdf --file ./doc2.docx --data '{"name":"team-docs","project_name":"Engineering"}'
+
+# From metadata file
+codemie sdk datasources create file --file ./report.pdf --json metadata.json
+```
+
+**`metadata.json`:**
+```json
+{
+  "name": "project-docs",
+  "project_name": "Engineering",
+  "description": "Key project documents",
+  "shared_with_project": true
+}
+```
+
+Supported file formats: PDF, DOCX, XLSX, TXT, MD, and other common document types. Max 10 files per create call.
+
+### Code Repository
+
+```bash
+codemie sdk datasources create code --data '{
+  "name": "main-repo",
+  "project_name": "Engineering",
+  "link": "https://github.com/org/repo",
+  "branch": "main",
+  "index_type": "code",
+  "description": "Main application codebase"
+}'
+```
+
+Output: `✓ Indexing of datasource main-repo has been started in the background`
+
+**Code-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `link` | ✅ | Repository HTTPS URL — e.g. `https://github.com/org/repo` |
+| `branch` | ✅ | Branch to index — e.g. `main`, `develop` |
+| `index_type` | ✅ | `"code"` = searchable code snippets; `"summary"` = LLM-generated summaries |
+| `files_filter` | — | Glob pattern to limit indexed files — e.g. `src/**/*.ts`, `**/*.py` |
+| `embeddings_model` | — | Embedding model `base_name` — get values: `codemie sdk llm list --embeddings --json` |
+| `summarization_model` | — | LLM model `base_name` for summary generation — get values: `codemie sdk llm list --json` |
+| `prompt` | — | Custom prompt template for summarization (overrides platform default) |
+| `docs_generation` | — | `true` = auto-generate documentation from code during indexing |
+
+**Full Code example:**
+```json
+{
+  "name": "backend-api",
+  "project_name": "Engineering",
+  "link": "https://github.com/org/backend",
+  "branch": "main",
+  "index_type": "code",
+  "description": "Backend API codebase",
+  "files_filter": "src/**/*.ts",
+  "docs_generation": true
+}
+```
+
+### Google Docs
+
+```bash
+codemie sdk datasources create google --data '{
+  "name": "team-docs",
+  "project_name": "Product",
+  "google_doc": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
+  "description": "Team documentation",
+  "shared_with_project": true
+}'
+```
+
+**Google-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `google_doc` | ✅ | Google Doc ID (from URL) or full Google Docs URL |
+
+## Update
+
+Same subcommands as create, but takes `<id>` after the type:
+
+```bash
+codemie sdk datasources update confluence <id> --data '{"name":"updated-wiki","project_name":"Documentation","cql":"space=NEWTEAM"}'
+codemie sdk datasources update jira <id> --data '{"name":"support-tickets","project_name":"Support","jql":"project=SUP AND status=Open"}'
+codemie sdk datasources update file <id> --data '{"name":"team-docs","project_name":"Engineering","description":"Updated docs"}'
+codemie sdk datasources update code <id> --json updates.json
+# Output: ✓ Incremental reindexing of datasource <name> has been started in the background
+codemie sdk datasources update azure-devops-wiki <id> --data '{"organization":"my-org","project":"my-project","wiki_name":"updated-wiki"}'
+codemie sdk datasources update azure-devops-work-item <id> --data '{"wiql_query":"SELECT [Id],[Title] FROM WorkItems WHERE [System.State]!='\''Closed'\''"}'
+codemie sdk datasources update xray <id> --data '{"jql":"project=QA AND issuetype in testExecutions()"}'
+codemie sdk datasources update sharepoint <id> --data '{"include_lists":true,"skip_reindex":true}'
+```
+
+**Update-only reindex flags** (add to any update payload):
+
+| Flag | Description |
+|------|-------------|
+| `full_reindex` | Discard existing index and re-fetch everything from scratch |
+| `incremental_reindex` | Only fetch and index content changed since last run (default for most types) |
+| `resume_indexing` | Resume a previously interrupted indexing job |
+| `skip_reindex` | Update metadata (name, description, etc.) without triggering any reindex |
+
+```bash
+# Rename without reindexing
+codemie sdk datasources update confluence <id> --data '{"name":"new-name","project_name":"Documentation","cql":"space=TEAM","skip_reindex":true}'
+
+# Force full re-fetch
+codemie sdk datasources update code <id> --data '{"name":"main-repo","project_name":"Engineering","link":"https://github.com/org/repo","branch":"main","index_type":"code","full_reindex":true}'
+```
+
+## Delete
+
+```bash
+codemie sdk datasources get <id>
+codemie sdk datasources delete <id>
+```
+
+## Linking to an Assistant
+
+After creating a datasource, attach it to an assistant via the assistant's `context` field.
+
+- Use `context_type: "knowledge_base"` for file, Confluence, Jira, Google, Azure DevOps Wiki, Azure DevOps Work Item, Xray, SharePoint, and JSON datasources.
+- Use `context_type: "code"` for code repository datasources.
+
+```bash
+# Get datasource ID
+DS_ID=$(codemie sdk datasources list --search 'my-docs' --json | jq -r '.[0].id')
+DS_NAME=$(codemie sdk datasources list --search 'my-docs' --json | jq -r '.[0].name')
+
+# Attach to assistant
+codemie sdk assistants update <assistant-id> --data "{
+  \"context\": [{\"id\": \"$DS_ID\", \"context_type\": \"knowledge_base\", \"name\": \"$DS_NAME\"}]
+}"
+```
+
+> See [Assistants — Linking a Datasource](assistants.md#linking-a-datasource) for full details.
+
+### Azure DevOps Wiki
+
+> Requires an **AzureDevOps integration** already configured in the project.
+> Get the integration ID: `codemie sdk integrations list --setting-type project --json | jq -r '.[] | select(.credential_type=="AzureDevOps") | "\(.id) \(.alias)"'`
+
+```bash
+codemie sdk datasources create azure-devops-wiki --data '{
+  "name": "ado-wiki",
+  "project_name": "Engineering",
+  "organization": "my-org",
+  "project": "my-project",
+  "wiki_name": "my-wiki",
+  "description": "Azure DevOps team wiki",
+  "shared_with_project": true
+}'
+```
+
+**Azure DevOps Wiki-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `organization` | — | Azure DevOps organization name |
+| `project` | — | Azure DevOps project name |
+| `wiki_name` | — | Name of the wiki to index |
+| `wiki_query` | — | Query to filter wiki pages |
+
+### Azure DevOps Work Item
+
+> Requires an **AzureDevOps integration** already configured in the project.
+
+```bash
+codemie sdk datasources create azure-devops-work-item --data '{
+  "name": "ado-work-items",
+  "project_name": "Engineering",
+  "organization": "my-org",
+  "project": "my-project",
+  "wiql_query": "SELECT [Id],[Title],[State] FROM WorkItems WHERE [System.TeamProject]=@project AND [System.State]!='\''Closed'\''",
+  "description": "Azure DevOps work items",
+  "shared_with_project": true
+}'
+```
+
+**Azure DevOps Work Item-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `organization` | — | Azure DevOps organization name |
+| `project` | — | Azure DevOps project name |
+| `wiql_query` | — | WIQL query to filter work items — e.g. `SELECT [Id],[Title] FROM WorkItems WHERE [System.State]!='Closed'` |
+
+### Xray
+
+> Requires a **Jira integration** already configured (Xray is a Jira plugin).
+> Get the integration ID: `codemie sdk integrations list --setting-type project --json | jq -r '.[] | select(.credential_type=="Jira") | "\(.id) \(.alias)"'`
+
+```bash
+codemie sdk datasources create xray --data '{
+  "name": "xray-tests",
+  "project_name": "QA",
+  "jql": "project=QA AND issuetype in testExecutions()",
+  "description": "Xray test execution data",
+  "shared_with_project": true
+}'
+```
+
+**Xray-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `jql` | ✅ | Jira Query Language to filter Xray test issues |
+
+### SharePoint
+
+> Requires a **SharePoint integration** or OAuth credentials.
+
+```bash
+codemie sdk datasources create sharepoint --data '{
+  "name": "sharepoint-docs",
+  "project_name": "Engineering",
+  "site_url": "https://company.sharepoint.com/sites/team",
+  "include_pages": true,
+  "include_documents": true,
+  "description": "SharePoint team site",
+  "shared_with_project": true
+}'
+```
+
+**SharePoint-specific fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `site_url` | ✅ | SharePoint site URL (must start with `https://`) |
+| `include_pages` | — | Index SharePoint site pages |
+| `include_documents` | — | Index document libraries |
+| `include_lists` | — | Index list items |
+| `max_file_size_mb` | — | Maximum file size in MB to index (1–500, default 50) |
+| `files_filter` | — | Gitignore-style file/path filter |
+| `auth_type` | — | Authentication method: `integration`, `oauth_codemie`, or `oauth_custom` |
+| `access_token` | — | OAuth access token (required for `oauth_codemie` and `oauth_custom`) |
+| `oauth_client_id` | — | Azure app client ID (`oauth_custom` only) |
+| `oauth_tenant_id` | — | Azure AD tenant ID (`oauth_custom` only) |
+| `embedding_model` | — | Override default embedding model |
+| `cron_expression` | — | Cron expression for scheduled reindexing |
+
+**Full SharePoint example:**
+```json
+{
+  "name": "team-sharepoint",
+  "project_name": "Engineering",
+  "site_url": "https://company.sharepoint.com/sites/engineering",
+  "include_pages": true,
+  "include_documents": true,
+  "include_lists": false,
+  "max_file_size_mb": 50,
+  "auth_type": "integration",
+  "description": "Engineering SharePoint site",
+  "shared_with_project": true
+}
+```
+
+### JSON Knowledge Base
+
+```bash
+codemie sdk datasources create json --data '{
+  "name": "json-data",
+  "project_name": "Team",
+  "description": "JSON knowledge base",
+  "shared_with_project": true
+}'
+```
+
+### Provider
+
+```bash
+codemie sdk datasources create provider --data '{
+  "name": "my-provider",
+  "project_name": "Team",
+  "description": "Provider datasource",
+  "shared_with_project": true
+}'
+```
+
+## Scripting
+
+```bash
+# Check for failed datasources
+codemie sdk datasources list --status failed --json | jq -r '.[] | "\(.name) (\(.project_name)): \(.error_message)"'
+
+# List by type
+codemie sdk datasources list --datasource-types knowledge_base_confluence --json
+```

package/dist/agents/plugins/claude/plugin/skills/codemie-sdk/examples/integrations.md

@@ -0,0 +1,242 @@
+# Integrations Examples
+
+## List
+
+```bash
+# User-level integrations (default)
+codemie sdk integrations list
+
+# Project-level integrations
+codemie sdk integrations list --setting-type project
+
+# Search and filter
+codemie sdk integrations list --search 'jira'
+codemie sdk integrations list --projects Engineering
+codemie sdk integrations list --page 0 --per-page 25 --json
+```
+
+**setting-type:** `user` (default) or `project`
+
+**List columns:** ID, Alias, Type, Project
+
+## Get
+
+```bash
+# By ID
+codemie sdk integrations get 6fcbb938-239c-40c4-b304-b1f3cec3d501
+codemie sdk integrations get 6fcbb938-239c-40c4-b304-b1f3cec3d501 --setting-type project --json
+
+# By alias (more convenient)
+codemie sdk integrations get-by-alias jira-main
+codemie sdk integrations get-by-alias jira-main --json
+```
+
+**JSON fields:** `id`, `alias`, `credential_type`, `project_name`, `setting_type`, `default`, `is_global`, `credential_values`, `date`, `update_date`, `user_id`, `created_by`
+
+> Note: Sensitive credential values are masked as `**********` in output.
+
+## Create
+
+```bash
+# Inline JSON
+codemie sdk integrations create --data '{
+  "credential_type": "Jira",
+  "project_name": "Engineering",
+  "alias": "jira-main",
+  "setting_type": "user",
+  "credential_values": [
+    {"key": "url", "value": "https://company.atlassian.net"},
+    {"key": "token", "value": "your-api-token"},
+    {"key": "username", "value": "bot@company.com"},
+    {"key": "alias", "value": "jira-main"}
+  ]
+}'
+
+# From file
+codemie sdk integrations create --json jira-integration.json
+```
+
+**Field reference:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `credential_type` | ✅ | Integration type — e.g. `"Jira"`, `"Confluence"`, `"Git"`, `"LiteLLM"` |
+| `project_name` | ✅ | Project to associate the integration with |
+| `credential_values` | ✅ | Array of `{"key": "...", "value": "..."}` credential pairs — **must include `alias` key** |
+| `setting_type` | — | `"user"` (default, personal) or `"project"` (team-shared) |
+| `alias` | — | Human-readable identifier used with `get-by-alias` |
+| `default` | — | `true` = mark as the default integration of this type for the project |
+| `enabled` | — | `false` = disable the integration without deleting it (default: `true`) |
+| `external_id` | — | External system identifier for cross-referencing with other tools |
+
+**All supported `credential_type` values:** `Jira`, `Confluence`, `Git`, `Kubernetes`, `AWS`, `GCP`, `Azure`, `Keycloak`, `Elastic`, `OpenAPI`, `Plugin`, `FileSystem`, `Scheduler`, `Webhook`, `Email`, `AzureDevOps`, `Sonar`, `SQL`, `Telegram`, `ZephyrScale`, `ZephyrSquad`, `ServiceNow`, `DIAL`, `A2A`, `MCP`, `LiteLLM`, `ReportPortal`, `Xray`, `SharePoint`
+
+> **Important:** `credential_values` **must include an `alias` key** with the same value as the top-level `alias` field, otherwise the API returns an error. Always add `{"key": "alias", "value": "<alias>"}` to the array.
+
+### Type examples
+
+**Confluence:**
+```json
+{
+  "credential_type": "Confluence",
+  "project_name": "Documentation",
+  "alias": "confluence-main",
+  "setting_type": "user",
+  "credential_values": [
+    {"key": "url", "value": "https://company.atlassian.net/wiki"},
+    {"key": "token", "value": "api-token"},
+    {"key": "username", "value": "admin@company.com"},
+    {"key": "alias", "value": "confluence-main"}
+  ]
+}
+```
+
+**Git:**
+```json
+{
+  "credential_type": "Git",
+  "project_name": "Engineering",
+  "alias": "github-main",
+  "setting_type": "project",
+  "credential_values": [
+    {"key": "url", "value": "https://github.com/org/repo"},
+    {"key": "token", "value": "ghp_yourToken"},
+    {"key": "alias", "value": "github-main"}
+  ]
+}
+```
+
+**LiteLLM:**
+```json
+{
+  "credential_type": "LiteLLM",
+  "project_name": "AI",
+  "alias": "litellm-proxy",
+  "setting_type": "user",
+  "credential_values": [
+    {"key": "base_url", "value": "http://localhost:4000"},
+    {"key": "api_key", "value": "sk-master-key"},
+    {"key": "alias", "value": "litellm-proxy"}
+  ]
+}
+```
+
+**AzureDevOps:**
+```json
+{
+  "credential_type": "AzureDevOps",
+  "project_name": "Engineering",
+  "alias": "ado-main",
+  "setting_type": "project",
+  "credential_values": [
+    {"key": "url", "value": "https://dev.azure.com/my-org"},
+    {"key": "token", "value": "your-pat-token"},
+    {"key": "alias", "value": "ado-main"}
+  ]
+}
+```
+
+**SharePoint:**
+```json
+{
+  "credential_type": "SharePoint",
+  "project_name": "Engineering",
+  "alias": "sharepoint-main",
+  "setting_type": "project",
+  "credential_values": [
+    {"key": "site_url", "value": "https://company.sharepoint.com/sites/team"},
+    {"key": "client_id", "value": "your-client-id"},
+    {"key": "client_secret", "value": "your-client-secret"},
+    {"key": "tenant_id", "value": "your-tenant-id"},
+    {"key": "alias", "value": "sharepoint-main"}
+  ]
+}
+```
+
+**Xray:**
+```json
+{
+  "credential_type": "Xray",
+  "project_name": "QA",
+  "alias": "xray-main",
+  "setting_type": "project",
+  "credential_values": [
+    {"key": "client_id", "value": "your-xray-client-id"},
+    {"key": "client_secret", "value": "your-xray-client-secret"},
+    {"key": "alias", "value": "xray-main"}
+  ]
+}
+```
+
+**ZephyrScale:**
+```json
+{
+  "credential_type": "ZephyrScale",
+  "project_name": "QA",
+  "alias": "zephyr-scale",
+  "setting_type": "user",
+  "credential_values": [
+    {"key": "url", "value": "https://company.atlassian.net"},
+    {"key": "token", "value": "your-zephyr-api-token"},
+    {"key": "alias", "value": "zephyr-scale"}
+  ]
+}
+```
+
+**ServiceNow:**
+```json
+{
+  "credential_type": "ServiceNow",
+  "project_name": "ITSM",
+  "alias": "servicenow-main",
+  "setting_type": "project",
+  "credential_values": [
+    {"key": "url", "value": "https://company.service-now.com"},
+    {"key": "username", "value": "api-user"},
+    {"key": "password", "value": "api-password"},
+    {"key": "alias", "value": "servicenow-main"}
+  ]
+}
+```
+
+**MCP:**
+```json
+{
+  "credential_type": "MCP",
+  "project_name": "AI",
+  "alias": "mcp-server",
+  "setting_type": "user",
+  "credential_values": [
+    {"key": "url", "value": "http://localhost:3000"},
+    {"key": "alias", "value": "mcp-server"}
+  ]
+}
+```
+
+Output: `✓ Specified credentials saved`
+
+## Update
+
+```bash
+codemie sdk integrations update <id> --data '{
+  "credential_type": "Jira",
+  "project_name": "Engineering",
+  "alias": "jira-main",
+  "credential_values": [
+    {"key": "url", "value": "https://company.atlassian.net"},
+    {"key": "token", "value": "new-rotated-token"},
+    {"key": "username", "value": "bot@company.com"}
+  ]
+}'
+```
+
+Output: `✓ Specified credentials updated`
+
+## Delete
+
+```bash
+codemie sdk integrations delete <id>
+codemie sdk integrations delete <id> --setting-type project
+```
+
+Output: `✓ Integration <id> deleted.`