{"id":27712,"library":"edgar-cli","title":"edgar-cli","description":"edgar-cli v0.1.4 is an agent-friendly CLI for accessing SEC EDGAR filings and company facts, designed for Node.js (>=18) and usable via npx without requiring Python. It provides commands for resolving tickers, listing/getting filings, extracting XBRL facts, and performing research syncing/querying with deterministic caching profiles. The CLI enforces SEC identity requirements via --user-agent or EDGAR_USER_AGENT and outputs stable JSON envelopes for automation. It differentiates from other EDGAR tools by being npx-friendly, TypeScript-native, and offering research capabilities with configurable filing profiles.","status":"active","version":"0.1.4","language":"javascript","source_language":"en","source_url":"https://github.com/finlayi/edgar-cli","tags":["javascript","edgar","sec","cli","npx","filings"],"install":[{"cmd":"npm install edgar-cli","lang":"bash","label":"npm"},{"cmd":"yarn add edgar-cli","lang":"bash","label":"yarn"},{"cmd":"pnpm add edgar-cli","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"Recommended usage is via npx; global install works but npx avoids version conflicts.","wrong":"npm install -g edgar-cli && edgar-cli --help (global install not required, use npx)","symbol":"edgar-cli (binary)","correct":"npx edgar-cli --help"},{"note":"The CLI reads this environment variable at runtime; it is required for all SEC commands.","wrong":"Setting EDGAR_USER_AGENT in .env file (CLI reads only from environment variable, not .env)","symbol":"EDGAR_USER_AGENT","correct":"export EDGAR_USER_AGENT='Your Name your.email@example.com'"}],"quickstart":{"code":"export EDGAR_USER_AGENT='Example User user@example.com'\nnpx edgar-cli resolve AAPL\nnpx edgar-cli filings list --id AAPL --form 10-K --query-limit 2\nnpx edgar-cli facts get --id AAPL --taxonomy us-gaap --concept Revenues --latest","lang":"javascript","description":"Demonstrates setting SEC identity and running resolve, filings list, and facts get commands."},"warnings":[{"fix":"Set EDGAR_USER_AGENT environment variable or pass --user-agent to each command.","message":"SEC identity is required for all commands; missing EDGAR_USER_AGENT or --user-agent causes 'IDENTITY_REQUIRED' error.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Use the official ticker symbol (e.g., AAPL for Apple Inc.).","message":"The --id parameter for resolve and filings commands expects a ticker symbol, not a CIK number or company name; incorrect input may yield empty results.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Copy the exact accession number from SEC EDGAR or use the filings list command to get valid accessions.","message":"Filing accession numbers must include leading zeros and be in the format SEC uses (e.g., 0000320193-26-000006); omitting leading zeros may cause 'not found' errors.","severity":"gotcha","affected_versions":">=0.1.0"}],"env_vars":null,"search_vec":"'18':25 'access':15 'agent':11,61,65 'agent-friend':10 'autom':72 'cach':50 'capabl':90 'cli':3,6,13,53,98 'command':35 'compani':20 'configur':92 'design':22 'determinist':49 'differenti':74 'edgar':2,5,17,63,77,96 'edgar-c':1,4 'enforc':54 'envelop':70 'extract':41 'fact':21,43 'file':18,40,93,100 'friend':12,83 'ident':56 'javascript':95 'json':69 'listing/getting':39 'nativ':86 'node.js':24 'npx':29,82,99 'npx-friend':81 'offer':88 'output':67 'perform':45 'profil':51,94 'provid':34 'python':32 'requir':31,57 'research':46,89 'resolv':37 'sec':16,55,97 'stabl':68 'syncing/querying':47 'ticker':38 'tool':78 'typescript':85 'typescript-n':84 'usabl':27 'user':60,64 'user-ag':59 'v0.1.4':7 'via':28,58 'without':30 'xbrl':42","created_at":"2026-05-09T05:51:41.163847+00:00","updated_at":"2026-05-09T05:51:41.163847+00:00","problems":[{"fix":"Set EDGAR_USER_AGENT environment variable or pass --user-agent 'Your Name your.email@example.com'.","cause":"EDGAR_USER_AGENT not set and --user-agent not provided.","error":"IDENTITY_REQUIRED: SEC EDGAR requires a declared identity"},{"fix":"Ensure the cache directory is writable, or set EDGAR_CACHE_DIR to a writable path; create the directory manually if needed.","cause":"Cache directory does not exist and cannot be created (permissions or missing parent directories).","error":"Error: No such file or directory: .../edgar-cli/cache/..."}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":"edgar","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/finlayi/edgar-cli","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/edgar-cli","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops","http-networking","data"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-05-09","next_check":"2026-08-07","install_tag":null}}