apigrip 0.4.2 → 0.5.2

package/README.md

@@ -67,6 +67,14 @@ apigrip curl GET /users -e Production
 apigrip list                                     # grouped by tag
 apigrip list --search "auth" --json              # fuzzy search, JSON output
 
+# Show endpoint details
+apigrip show GET /users                          # parameters, schemas, responses
+apigrip show POST /users --json                  # full JSON output
+
+# Print parsed spec
+apigrip spec                                     # dereferenced JSON
+apigrip spec --raw                               # original file as-is
+
 # Manage projects
 apigrip projects                                 # list bookmarks
 apigrip projects add ./my-api                    # bookmark a directory
@@ -89,6 +97,18 @@ apigrip last GET /users --json                   # full JSON output
 apigrip mcp --project /path/to/api
 ```
 
+### Shell completion
+
+```bash
+# Zsh — copy to your fpath
+cp "$(npm root -g)/apigrip/completions/_apigrip" /usr/local/share/zsh/site-functions/
+# or symlink into any directory in your $fpath, then:
+autoload -Uz compinit && compinit
+
+# Bash
+apigrip completion >> ~/.bashrc
+```
+
 ### Exit codes
 
 | Code | Meaning |
@@ -207,7 +227,7 @@ apigrip/
 │   ├── index.js      Yargs command registration
 │   ├── output.js     CLI formatting (table, JSON, color)
 │   ├── resolve-project.js  Shared project context resolution
-│   └── commands/     serve, send, curl, list, projects, env, last, mcp
+│   └── commands/     serve, send, curl, list, show, spec, projects, env, last, mcp
 ├── core/             Shared logic (spec parsing, curl, environments, persistence)
 │   ├── spec-discovery.js    Find OpenAPI spec in a directory
 │   ├── spec-parser.js       Parse/dereference specs (2.0, 3.0, 3.1)

package/cli/commands/show.js

@@ -0,0 +1,148 @@
+// cli/commands/show.js — Show details for a specific endpoint
+
+import { parseSpec, getEndpointDetails } from '../../core/spec-parser.js';
+import { colorMethod } from '../output.js';
+import { resolveProjectContext } from '../resolve-project.js';
+
+const DIM = '\x1b[2m';
+const BOLD = '\x1b[1m';
+const RESET = '\x1b[0m';
+const CYAN = '\x1b[36m';
+const YELLOW = '\x1b[33m';
+
+function indent(text, level = 2) {
+  const pad = ' '.repeat(level);
+  return text.split('\n').map(l => pad + l).join('\n');
+}
+
+function formatSchema(schema, depth = 0) {
+  if (!schema) return DIM + 'any' + RESET;
+  const pad = '  '.repeat(depth);
+
+  if (schema.type === 'object' && schema.properties) {
+    const required = new Set(schema.required || []);
+    const lines = ['{'];
+    for (const [key, prop] of Object.entries(schema.properties)) {
+      const req = required.has(key) ? ` ${YELLOW}*required${RESET}` : '';
+      const type = prop.type || 'any';
+      const desc = prop.description ? `  ${DIM}${prop.description}${RESET}` : '';
+      if (prop.type === 'object' && prop.properties) {
+        lines.push(`${pad}  ${key}: ${formatSchema(prop, depth + 1)}${req}${desc}`);
+      } else if (prop.type === 'array' && prop.items) {
+        const itemType = prop.items.type || 'any';
+        lines.push(`${pad}  ${key}: ${type}<${itemType}>${req}${desc}`);
+      } else {
+        lines.push(`${pad}  ${key}: ${type}${req}${desc}`);
+      }
+    }
+    lines.push(`${pad}}`);
+    return lines.join('\n');
+  }
+
+  if (schema.type === 'array' && schema.items) {
+    return `array<${schema.items.type || 'any'}>`;
+  }
+
+  return schema.type || 'any';
+}
+
+export async function showCommand(argv) {
+  const { specPath } = await resolveProjectContext(argv);
+  if (!specPath) {
+    console.error('No spec file found');
+    process.exit(2);
+  }
+
+  let spec;
+  try {
+    spec = await parseSpec(specPath);
+  } catch (err) {
+    console.error(`Spec parse error: ${err.message}`);
+    process.exit(2);
+  }
+
+  const method = argv.method.toUpperCase();
+  const pathArg = argv.path;
+  const apiPath = typeof pathArg === 'string' ? (pathArg.startsWith('/') ? pathArg : '/' + pathArg) : '/' + String(pathArg);
+
+  const details = getEndpointDetails(spec, method, apiPath);
+  if (!details) {
+    console.error(`Endpoint not found: ${method} ${apiPath}`);
+    process.exit(3);
+  }
+
+  if (argv.json) {
+    console.log(JSON.stringify(details, null, 2));
+    return;
+  }
+
+  const lines = [];
+
+  // Header
+  lines.push(`${colorMethod(method)} ${BOLD}${apiPath}${RESET}`);
+  if (details.summary) lines.push(details.summary);
+  if (details.description) lines.push(`${DIM}${details.description}${RESET}`);
+  if (details.tags && details.tags.length) lines.push(`${DIM}Tags: ${details.tags.join(', ')}${RESET}`);
+  if (details.deprecated) lines.push(`${YELLOW}DEPRECATED${RESET}`);
+
+  // Parameters
+  const params = details.parameters || [];
+  if (params.length > 0) {
+    lines.push('');
+    lines.push(`${BOLD}PARAMETERS${RESET}`);
+    for (const p of params) {
+      const req = p.required ? ` ${YELLOW}*required${RESET}` : '';
+      const type = p.schema?.type || 'string';
+      const def = p.schema?.default != null ? ` ${DIM}(default: ${p.schema.default})${RESET}` : '';
+      lines.push(`  ${CYAN}${p.in}${RESET}  ${p.name}: ${type}${req}${def}`);
+      if (p.description) lines.push(`        ${DIM}${p.description}${RESET}`);
+    }
+  }
+
+  // Request body
+  const reqBody = details.request_body;
+  if (reqBody) {
+    lines.push('');
+    lines.push(`${BOLD}REQUEST BODY${RESET}${reqBody.required ? ` ${YELLOW}*required${RESET}` : ''}`);
+    if (reqBody.content) {
+      for (const [ct, media] of Object.entries(reqBody.content)) {
+        lines.push(`  ${DIM}${ct}${RESET}`);
+        if (media.schema) {
+          lines.push(indent(formatSchema(media.schema), 4));
+        }
+      }
+    }
+  }
+
+  // Responses
+  const responses = details.responses || {};
+  if (Object.keys(responses).length > 0) {
+    lines.push('');
+    lines.push(`${BOLD}RESPONSES${RESET}`);
+    for (const [code, resp] of Object.entries(responses)) {
+      const desc = resp.description || '';
+      lines.push(`  ${CYAN}${code}${RESET}  ${desc}`);
+      if (resp.content) {
+        for (const [ct, media] of Object.entries(resp.content)) {
+          lines.push(`    ${DIM}${ct}${RESET}`);
+          if (media.schema) {
+            lines.push(indent(formatSchema(media.schema), 6));
+          }
+        }
+      }
+    }
+  }
+
+  // Servers
+  const servers = details.servers || [];
+  if (servers.length > 0) {
+    lines.push('');
+    lines.push(`${BOLD}SERVERS${RESET}`);
+    for (const s of servers) {
+      const desc = s.description ? ` ${DIM}(${s.description})${RESET}` : '';
+      lines.push(`  ${s.url}${desc}`);
+    }
+  }
+
+  console.log(lines.join('\n'));
+}

package/cli/index.js

@@ -62,6 +62,17 @@ const cli = yargs(hideBin(process.argv))
     const { listCommand } = await import('./commands/list.js');
     await listCommand(argv);
   })
+  .command('show <method> <path>', 'Show endpoint details', (yargs) => {
+    return yargs
+      .positional('method', { type: 'string', describe: 'HTTP method' })
+      .positional('path', { type: 'string', describe: 'API path' })
+      .option('json', { type: 'boolean', describe: 'Full JSON output' })
+      .option('spec', { type: 'string', describe: 'Path to spec file' })
+      .option('project', { type: 'string', describe: 'Project directory' });
+  }, async (argv) => {
+    const { showCommand } = await import('./commands/show.js');
+    await showCommand(argv);
+  })
   .command('projects [action] [dir]', 'Manage project bookmarks', (yargs) => {
     return yargs
       .positional('action', { choices: ['add', 'remove'], describe: 'Action' })
@@ -114,5 +125,7 @@ const cli = yargs(hideBin(process.argv))
     await mcpCommand(argv);
   })
   .demandCommand(1, 'You need at least one command')
+  .strictCommands()
+  .completion('completion', 'Generate shell completion script')
   .help()
   .argv;

package/completions/_apigrip

@@ -0,0 +1,144 @@
+#compdef apigrip
+
+_apigrip() {
+  local -a commands
+  commands=(
+    'serve:Start the web UI server'
+    'send:Send an API request'
+    'curl:Generate curl command'
+    'list:List endpoints from spec'
+    'show:Show endpoint details'
+    'projects:Manage project bookmarks'
+    'last:Show last cached response'
+    'env:Manage environments'
+    'spec:Print the parsed OpenAPI spec'
+    'mcp:Start MCP server'
+    'completion:Generate shell completion script'
+  )
+
+  local -a global_opts
+  global_opts=(
+    '--help[Show help]'
+    '--version[Show version number]'
+  )
+
+  local -a project_opts
+  project_opts=(
+    '--project[Project directory]:directory:_directories'
+    '--spec[Path to spec file]:file:_files'
+  )
+
+  _arguments -C \
+    '1:command:->command' \
+    '*::arg:->args'
+
+  case $state in
+    command)
+      _describe -t commands 'apigrip command' commands
+      ;;
+    args)
+      case $words[1] in
+        serve)
+          _arguments \
+            '--port[Port to listen on]:port' \
+            '--host[Host to bind to]:host' \
+            '--open[Open browser on start]' \
+            '--no-browse[Disable directory browsing]' \
+            $project_opts \
+            $global_opts
+          ;;
+        send)
+          _arguments \
+            '1:method:(GET POST PUT PATCH DELETE HEAD OPTIONS)' \
+            '2:path' \
+            '-d[Request body]:body' \
+            '--data[Request body]:body' \
+            '-e[Environment name]:env' \
+            '--env[Environment name]:env' \
+            '*--query[Query params (key=value)]:param' \
+            '*--header[Headers (Name: value)]:header' \
+            '*--pathParam[Path params (key=value)]:param' \
+            '-v[Verbose output]' \
+            '--verbose[Verbose output]' \
+            '-i[Include headers]' \
+            '--headers[Include headers]' \
+            '--dry-run[Print without sending]' \
+            '--curl[Print curl command only]' \
+            '--filter[jq filter for response body]:filter' \
+            $project_opts \
+            $global_opts
+          ;;
+        curl)
+          _arguments \
+            '1:method:(GET POST PUT PATCH DELETE HEAD OPTIONS)' \
+            '2:path' \
+            '-d[Request body]:body' \
+            '--data[Request body]:body' \
+            '-e[Environment name]:env' \
+            '--env[Environment name]:env' \
+            '*--query[Query params (key=value)]:param' \
+            '*--header[Headers (Name: value)]:header' \
+            '*--pathParam[Path params (key=value)]:param' \
+            $project_opts \
+            $global_opts
+          ;;
+        list)
+          _arguments \
+            '--tag[Filter by tag]:tag' \
+            '--search[Search endpoints]:search' \
+            '--json[JSON output]' \
+            $project_opts \
+            $global_opts
+          ;;
+        show)
+          _arguments \
+            '1:method:(GET POST PUT PATCH DELETE HEAD OPTIONS)' \
+            '2:path' \
+            '--json[Full JSON output]' \
+            $project_opts \
+            $global_opts
+          ;;
+        projects)
+          _arguments \
+            '1:action:(add remove)' \
+            '2:directory:_directories'
+          ;;
+        last)
+          _arguments \
+            '1:method:(GET POST PUT PATCH DELETE HEAD OPTIONS)' \
+            '2:path' \
+            '--json[Full JSON output]' \
+            '-v[Verbose output]' \
+            '--verbose[Verbose output]' \
+            '-i[Include headers]' \
+            '--headers[Include headers]' \
+            $project_opts \
+            $global_opts
+          ;;
+        env)
+          _arguments \
+            '1:action:(show set delete import)' \
+            '2:name' \
+            '3:key' \
+            '4:value' \
+            '--import-name[Target environment name]:name' \
+            '--merge[Merge with existing values]' \
+            '--project[Project directory]:directory:_directories'
+          ;;
+        spec)
+          _arguments \
+            '--raw[Print raw spec file]' \
+            $project_opts \
+            $global_opts
+          ;;
+        mcp)
+          _arguments \
+            $project_opts \
+            $global_opts
+          ;;
+      esac
+      ;;
+  esac
+}
+
+_apigrip

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apigrip",
-  "version": "0.4.2",
+  "version": "0.5.2",
   "description": "A spec-first, read-only OpenAPI client for developers",
   "type": "module",
   "main": "./lib/index.cjs",
@@ -20,7 +20,8 @@
     "lib/",
     "mcp/",
     "server/",
-    "client/dist/"
+    "client/dist/",
+    "completions/"
   ],
   "scripts": {
     "start": "node cli/index.js serve",