help
Get help information for the Codex CLI to assist with code analysis, generation, and refactoring tasks.
Instructions
Get Codex CLI help information
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/handlers.ts:186-212 (handler)The handler class for the 'help' tool, which executes 'codex --help' and returns the output.
export class HelpToolHandler { async execute(args: unknown): Promise<ToolResult> { try { HelpToolSchema.parse(args); const result = await executeCommand('codex', ['--help']); return { content: [ { type: 'text', text: result.stdout || 'No help information available', }, ], }; } catch (error) { if (error instanceof ZodError) { throw new ValidationError(TOOLS.HELP, error.message); } throw new ToolExecutionError( TOOLS.HELP, 'Failed to execute help command', error ); } } } - src/types.ts:53-53 (schema)The Zod schema definition for the 'help' tool inputs (currently empty object).
export const HelpToolSchema = z.object({}); - src/tools/handlers.ts:259-259 (registration)The registration of the HelpToolHandler in the toolHandlers registry.
[TOOLS.HELP]: new HelpToolHandler(),