tools
Usage: deepline tools [options] [command]
Search by intent or structured filters, describe, and execute atomic provider
tools.
Options:
-h, --help display help for command
Commands:
connect [options] <provider> Connect a provider with credentials or OAuth
(owner/admin required).
list [options] [category] Browse tool categories, or list every tool in a
category.
search [options] [task] Deprecated. Use deepline search --type <types>.
grep [options] <query> Regex grep over tool ids, descriptions,
categories, and input fields.
help [command] display help for command
Explanation:
Purpose:
The atomic provider layer: one operation per call (search people, enrich a
company, verify an email), priced per call in Deepline credits.
When:
For one-off lookups, candidate searches, or when search finds no play
for the job. CSV-shaped work goes through a play, which retries, reuses
completed rows, and exports.
The sequence:
search <words> ranked tools and plays for an intent
describe <id> required input fields, pricing, output shape
run <id> --input '{...}' run it
Cost:
search, describe, list, and grep are free. Running a tool can spend
credits; run <id> --dry-run shows the price.
tools connect
Usage: deepline tools connect [options] <provider>
Connect a provider with credentials or OAuth (owner/admin required).
Options:
--credentials-file <path> JSON object of credential field names and string
values; keep this file private
--oauth Return an OAuth authorization URL
--preset <id> Server-defined access preset (HubSpot only)
--scopes <scopes> Comma-separated OAuth scopes
--optional-scopes <scopes> Comma-separated optional OAuth scopes
--json Emit a confirmation without credential values
-h, --help display help for command
Explanation:
Purpose:
Connect a provider to the active workspace. Requires an owner or admin.
Input:
--credentials-file <path> saves a private JSON object of credential strings.
A provider that takes one API key reads {"api_key": "..."}; a file with one
field is accepted whatever the field is named. A multi-field provider (for
example a warehouse) rejects a missing field and lists its accepted field
names in the error.
--oauth prints an authorization URL. Open it in a browser signed into the
same Deepline workspace and finish provider consent.
HubSpot: --preset read-crm, update-crm, marketing, sales-sequences, tickets, or all.
all requests every supported capability, including write and admin access.
For custom access use comma-separated --scopes and --optional-scopes instead
of --preset. --scopes must be nonempty; an empty --optional-scopes string
requests no optional scopes. Scope names and presets
are validated by the server; requested access may differ from granted access.
Output:
Credentials: confirmation without secret values.
OAuth: URL, or {provider, redirect_url} with --json. This does not confirm a
completed connection. The browser must finish authorization.
Cost:
Does not spend Deepline credits.
Examples:
deepline tools connect heyreach --credentials-file ./heyreach.json
deepline tools connect hubspot --oauth --preset read-crm
tools list
Usage: deepline tools list [options] [category]
Browse tool categories, or list every tool in a category.
Options:
--categories <categories> Comma-separated categories filter (back-compat
alias for the positional)
--compact Drop verbose fields from JSON output
--json Emit JSON output
-h, --help display help for command
Explanation:
Purpose:
Browse discoverable tool categories, or list every discoverable tool in one
category exhaustively.
When:
To see what kinds of tools exist (bare tools list) or to enumerate one
category without ranking (tools list email_finder).
List/search omit hidden tools. Check a known id with describe; supported
hidden tools can still resolve for compatibility. Absence is not removal.
Input:
Optional positional category. --json prints JSON.
Output (JSON):
Bare: one entry per category with its tool count. With a category: one row
per tool with required inputs and a pricing hint. Never truncated.
Cost:
Free.
tools search
Usage: deepline tools search [options] [task]
Deprecated. Use deepline search --type <types>.
Options:
--all Include plays your workspace created
--compact Accepted for compatibility; results are compact
--categories <categories> Only tools in these categories, comma-separated
--limit <count> Results per page, 1-50
--offset <count> Results to skip, for the next page
--summary-width <chars> Description characters per result (default 140)
--json Print JSON instead of the readable list
-h, --help display help for command
tools grep
Usage: deepline tools grep [options] <query>
Regex grep over tool ids, descriptions, categories, and input fields.
Options:
--categories <categories> Comma-separated categories to filter inventory
--mode <mode> Grep matching mode: all, any, or phrase
--compact Drop verbose fields from JSON output
--json Emit JSON output
-h, --help display help for command
Explanation:
Purpose:
Case-insensitive regex (RE2) filtering of the tool registry by id, provider,
description, categories, or input field names.
When:
When you know a provider, id pattern, or field name and want every matching
tool rather than a ranked guess. Use search for intent queries.
Input:
A query of regex terms; --mode all (default, AND), any (OR), or phrase
(whole query is one pattern); --categories.
Output (JSON):
Every matching tool, id matches first: tools[] with id, provider,
displayName, description, categories, matchedFields, and executeCommand.
Cost:
Free.