docs: clarify CLI quickstart#17
Draft
daniel-scrivner wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Scope
x-api-keyauthentication.Factual self-audit
secapi filings latest --ticker AAPL --form 10-K,SECAPI_API_KEY,--api-key-stdin, and MCP setup commands were verified against this branch and current canonical docs.GitHub metadata
Command-line client for source-backed SEC filings and financial data.https://docs.secapi.ai; addedsec-filingstopic.Registry delta
@secapi/cli@1.4.0description and repositorypackage.jsondescription match, while both source and published homepage remainhttps://secapi.ai/developers.Validation
git diff --checkbun run typecheckreports the installed@secapi/sdk-jsis missing multiple members used by the CLI;bun testhas 22 failures in situations, filing-event, and fund-letter command coverage. A focused situations test exits 1 before making its expected request.Tracks OMNI-5503 under OMNI-5326.