[DOCS] Ambiguity in 'piped input' deprecation between changelog and `common-workflows` documentation
Documentation Type
Unclear/confusing documentation
Documentation Location
https://docs.anthropic.com/en/docs/claude-code/common-workflows
Section/Topic
Pipe in, pipe out
Current Documentation
Pipe in, pipe out
Suppose you want to pipe data into Claude, and get back data in a structured format.
Pipe data through Claude:
cat build-error.txt | claude -p 'concisely explain the root cause of this build error' > output.txt
<Tip>
Tips:
- Use pipes to integrate Claude into existing shell scripts
- Combine with other Unix tools for powerful workflows
- Consider using --output-format for structured output
</Tip>
What's Wrong or Missing?
The Conflict
1. Changelog Deprecation Notice (v1.0.113):
The official changelog indicates a breaking change related to piped input:
## 1.0.113
- Deprecated piped input in interactive mode
2. common-workflows Documentation Example:
The documentation page en/docs/claude-code/common-workflows includes a section titled "Use Claude as a unix-style utility" with an explicit example of using piped input.
The Ambiguity
The core of the issue lies in the distinction between "interactive mode" and the headless/print mode invoked by the -p flag.
- The changelog specifies deprecation for "interactive mode".
- The documentation example uses the
-pflag, which thecli-referencedocumentation defines as running "without interactive mode".
This leaves an important question unanswered for users:
Is piped input still officially supported in non-interactive (-p) mode, or has the feature been fully removed and the documentation is now outdated?
Suggested Improvement
Suggested Actions
To resolve this, we recommend the following:
- Clarify the intended behavior: Determine whether piped input is still a supported workflow for non-interactive (
-p) use cases. - Update the documentation accordingly:
- If piping in
-pmode is still supported: Thecommon-workflowsdocumentation is correct, but it might be helpful to add a note clarifying that this method only works in non-interactive mode. The changelog could also be updated for clarity (e.g., "Deprecated piped input for interactive sessions; non-interactive piping with-pis still supported."). - If all piped input is deprecated: The "Pipe in, pipe out" section and its corresponding example should be removed from
en/docs/claude-code/common-workflowsto avoid confusion and prevent users from relying on a deprecated feature.
Resolving this will ensure users have a clear and accurate understanding of Claude Code's capabilities.
Impact
High - Prevents users from using a feature
Additional Context
_No response_
This issue has 3 comments on GitHub. Read the full discussion on GitHub ↗