Skip to content

Improve apify call input UX#1212

Open
patrikbraborec wants to merge 1 commit into
masterfrom
fix/call-input-help-ux
Open

Improve apify call input UX#1212
patrikbraborec wants to merge 1 commit into
masterfrom
fix/call-input-help-ux

Conversation

@patrikbraborec

@patrikbraborec patrikbraborec commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Expand apify call --input help to clarify inline JSON object usage, shell quoting, and --input-file for file input.
  • Add call-scoped schema-discovery hints for parse/path/object-shape input errors.
  • Regenerate CLI reference docs and cover the new hint behavior with local tests.

Closes #1210

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions github-actions Bot added this to the 143rd sprint - DX team milestone Jun 23, 2026
@github-actions github-actions Bot added t-dx Issues owned by the DX team. tested Temporary label used only programatically for some analytics. labels Jun 23, 2026
char: 'i',
description: 'Optional JSON input to be given to the Actor.',
description:
'Optional inline JSON object input for the Actor. Wrap the JSON in quotes to avoid shell parsing issues. For JSON files, use --input-file.',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'Optional inline JSON object input for the Actor. Wrap the JSON in quotes to avoid shell parsing issues. For JSON files, use --input-file.',
'Optional inline JSON object input for the Actor. To avoid shell parsing issues, wrap the JSON in quotes. For JSON files, use --input-file.',

'Executes Actor remotely using your authenticated account.\n' +
'Reads input from local key-value store by default.';
'Reads input from local key-value store by default.\n' +
'Inspect the input schema first with "apify actors info <actor> --input".';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'Inspect the input schema first with "apify actors info <actor> --input".';
'To inspect the input schema before creating a JSON input, use "apify actors info <actor> --input".';

Jumping from "executes" and "reads" to an imperative creates some dissonance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-dx Issues owned by the DX team. tested Temporary label used only programatically for some analytics.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve apify call --input help/UX to cut avoidable input failures

3 participants