@noxinfluencer/cli
v0.5.4
Published
NoxInfluencer CLI — agent-friendly creator discovery, analysis, contact lookup, quota, pricing, monitoring & marketing ops
Maintainers
Readme
@noxinfluencer/cli
NoxInfluencer CLI for creator discovery, creator analysis, platform email outreach, external contact lookup, video monitoring, marketing operations, Shopify affiliate marketing, product center, brand monitoring, user feedback, skill quota inspection, and membership plan lookup.
Install
Global install:
npm install -g @noxinfluencer/cliOne-off execution:
npx @noxinfluencer/cli --helpAfter installation, the executable command is:
noxinfluencerRequirements
- Node.js 18+
- Access to a compatible KOL Claw server
- A valid API key
Quick Start
If you are starting from scratch:
- Sign in and authorize the CLI:
noxinfluencer loginThe CLI prints an authorization URL and opens it when possible. Complete SaaS login/registration and authorization in any browser; the CLI then creates or reuses a non-expiring API key and saves it locally.
For an Agent, container, or remote terminal, return the URL to the user first and wait separately:
noxinfluencer login start --json
noxinfluencer login wait <login_id>login start never opens a browser and never prints the secret device code. Use noxinfluencer login --browser only when a local loopback callback is available.
- Manual fallback: get your API key:
- English:
https://www.noxinfluencer.com/skills/dashboard?utm_source=skill&utm_medium=cli - Chinese:
https://cn.noxinfluencer.com/skills/dashboard?utm_source=skill&utm_medium=cli
Then configure it securely:
printf '%s\n' "$NOXINFLUENCER_API_KEY" | noxinfluencer auth --key-stdinFor CLI-generated onboarding URLs and hints in Chinese, add --lang zh:
noxinfluencer --lang zh doctorCheck quota:
noxinfluencer quota
noxinfluencer quota usage --days 7Check pricing:
noxinfluencer pricing
noxinfluencer pricing tools --charged-onlySearch creators:
noxinfluencer creator search --platform youtube --keywords '[beauty,skincare]' --page_size 3
noxinfluencer creator search --platform youtube --creator_name "MrBeast" --page_size 5
noxinfluencer creator search --platform tiktok --keywords '[coffee,review]' --keyword_match all
noxinfluencer creator search --platform instagram --keywords '[books]' --exclude_keywords '[parenting]' --hide_cooperated --hide_contacting --hide_contacted_scope teamAPI-backed skill calls can consume both:
- the account's remaining Skill quota
- the underlying SaaS-side capability quota / entitlement for the requested operation
Core Commands
login- device authorization sign-in that saves an API key locally; uselogin start|status|waitfor Agents, orlogin --browserfor a local loopback PKCE shortcutauth- save API keyquota/quota usage- show the current Skill quota snapshot and historical consumption statisticspricing/pricing tools- show public membership plans and current server-side Skill Credit unit pricescreator search- search creators on YouTube, TikTok, or Instagram by either topic--keywordsor one--creator_name; supports topic exclusions plus the SaaS completed-cooperation, active-cooperation, CRM-communication, contacted-scope, and collection filters in the same request; defaults topage_size=20, supports up to--page_size 100, and charges only for returned creators; search results do not expose creator identity fields beyond search itemidcreator search --exclude_disputed- omit creators with recorded disputes when building an outreach shortlistcreator search-filter/creator search-filter-options- inspect SaaS hide/deduplication choices or apply them to an already returned result page; prefer integratedcreator search --hide_*for new searchescreator not-interested list|add|remove- mark selected encrypted creator IDs as Not interested, inspect the user-scoped list, or remove that mark; writes default to dry-run and are freecreator lookalikes [source_creator_id]- find similar creators from a source creator ID, source URL, or--source-platform --source-channel-id; requires--target-platformand supports up to--page_size 100creator export/creator lookalikes-export- export 1-100 explicitly selected creator IDs from search or lookalike results in SaaS base or deep mode; poll and download through the sharedexportcommandscreator export-preview- use the same deep-export body to preview SaaS export/contact quota without creating a task or consuming Skill Creditcreator profile [creator_id]/creator profile --detail- choose exactly one selector:[creator_id],--url, or--platform --channel-id; creator read responses includecreator_id,creator_name,channel_handle,channel_url, andsocial_mediacreator audience [creator_id]/creator audience --detail- choose the same selector modescreator cooperation [creator_id]/creator cooperation --detail- choose the same selector modescreator content [creator_id]/creator content --detail- choose the same selector modescreator contacts [creator_id]- retrieve visible/exportable contact info for external outreach; NoxInfluencer email tasks should add search/profilecreator_idvalues directly insteadmonitor list|create|add-task|import-file|import-report|report|dashboard-report|task-report|tasks|history|summary- manage published-content monitoring, including SaaS Excel imports and reportsmonitor auto-track list|get|import-file|import-template|import-report- create and inspect rules that automatically monitor newly published creator content; file imports are all-or-nothingmonitor tasks- list monitored videos in a project; task items return the same creator identity fieldsmonitor history- get task-level history points bytask_idwith--granularity daily|hourlymonitor summary- get project-level aggregated summarycampaign list|get|init|create|update|delete|dropdown|dashboard|product-images- manage campaign skeleton data and upload product images to public OSS; write commands default to dry-runcollection list|get|create|update|delete|items|resources|export- manage collections and create async export tasks;items/resources/exportstay JSON-first via--body-filecollection add-creators- add creators returned by search/read commands to one or more collectionscollection import-file- import the user's owned creator URLs into one collection from a spreadsheetcollection batch-delete|batch-move|batch-copy|batch-label validate|preview|apply- single-source batch ops; usevalidateto check selector and target wiring,previewto inspectmatched_countandsample_rows, thenapply --forceto executecollection refresh|refresh-email|unlock-audience validate|preview|apply- single-source high-side-effect ops; reuse the same selector contract as batch commands, and usepreviewbeforeapply --forcecollection add-to-crm validate|preview|apply- whole collection + platform only in v1; no filtered or explicit channel subset supportcrm list|get|update|archive|restore|import-file|import-report|labels|groups|batch-update|export|add-to-email- manage NoxInfluencer CRM channels, SaaS-format spreadsheet imports and reports, labels, groups, batch status/label updates, exports, and email recipient bridgingemail list|get|create|update|copy|delete|recipients|content|sender|templates|products|attachments|collaborators|send|schedule|cancel|report|team-summary|team-breakdown- manage email tasks, recipients, content, sender identity, templates, product cards, private attachments, collaborators, sending, scheduling, and reporting; useemail sender list [task_id]to discover Gmail, Outlook, enterprise, or Nox sender IDs safelyemail recipients filter|import-file- read or update task-level SaaS recipient hide/deduplication settings, or import recipients from a SaaS-format Excel filemessage list|project-filters|creator-filters|get|projects|archive|labels|coop|draft|attachments|send|schedule|cancel|templates- manage existing NoxInfluencer message threads, replies, and whole-creator conversation archive; message archive is separate from CRM archiveproduct list|get|analyze-link|create|update|delete|image|tags- manage product center records, public thumbnail uploads, and custom tagsshort-link list|get|create|update|delete|export-list|export-effect- manage normal Nox short links and stream SaaS-generated Excel reports; Shopify affiliate campaign tracking links are separateaffiliation stores|campaigns|members- manage Shopify affiliate stores after SaaS authorization, campaigns, members, spreadsheet imports, tracking links, discount codes, and performance reads; store authorization stays in SaaSbrand-monitor search|rank|list|get|competition-matrix|cooperate-matrix|influencer-portrait|defense-gap|product-*|*-list|*-export|add|unlock-base|unlock-high- discover brands globally, then read and manage account brand-monitor data and exportsfeedback submit|list|inbox|get|reply|notifications|attachments- send free product feedback, bugs, usage questions, or feature requests; supports screenshot/log upload and owned attachment downloaddispute options|search|mine|records|get|report|update|withdraw- review creator collaboration dispute history, then submit evidence-backed reports or manage your own pending reports; requires paid membership but consumes no Skill Creditexport list|get|download- inspect creator, collection, CRM, and brand-monitor export tasks and directly download authorized files;export downloadrequires--output
For the first lookup, use --url or --platform --channel-id. All creator read commands return data.creator_id; reuse that value for follow-up calls.
Examples:
noxinfluencer creator profile --url https://www.youtube.com/channel/UC4qk9TtGhBKCkoWz5qGJcGg
noxinfluencer creator profile --platform youtube --channel-id UC4qk9TtGhBKCkoWz5qGJcGg
noxinfluencer creator profile <creator_id>
noxinfluencer collection batch-copy preview --body-file batch-copy.json
noxinfluencer collection batch-copy apply --body-file batch-copy.json --force
noxinfluencer collection refresh-email preview --body-file refresh-email.json
noxinfluencer collection unlock-audience apply --body-file unlock-audience.json --force
noxinfluencer collection add-creators --body-file add-creators.json --force
noxinfluencer collection import-file <collection_id> --file creators.xlsx --force
noxinfluencer collection add-to-crm apply --body-file add-to-crm.json --force
noxinfluencer collection export --body-file export.json --force
noxinfluencer monitor import-file --project_id 7101 --file monitor.xlsx --force
noxinfluencer monitor import-report --body-file monitor-failures.json --output invalid-tasks.xlsx
noxinfluencer monitor auto-track import-file --project_id 7101 --rule_name "Hisense launches" --keywords '[Hisense,TV]' --file influencers.xlsx --force
noxinfluencer monitor report --body-file monitor-report.json --output monitor-report.xlsx
noxinfluencer monitor dashboard-report --body-file dashboard-report.json --output dashboard.xlsx
noxinfluencer monitor task-report 9120 --start-date 2026-07-01 --end-date 2026-07-15 --output task-report.xlsx
noxinfluencer crm import-file --file crm-import.xlsx --force
noxinfluencer crm import-report --body-file crm-import-report.json --output crm-failed.xlsx
noxinfluencer email collaborators list
noxinfluencer email recipients filter options
noxinfluencer email recipients import-file <task_id> --file recipients.xlsx --force
noxinfluencer message templates attachments upload <template_id> --file brief.pdf --force
noxinfluencer message templates use <template_id> --body-file template-use.json --force
noxinfluencer product image upload --file product.jpg --force
noxinfluencer product list
noxinfluencer campaign product-images upload --file campaign-product.jpg --force
noxinfluencer short-link create --body-file short-link.json --force
noxinfluencer short-link get <short_link_id>
noxinfluencer short-link export-list --body-file short-link-export.json --output short-links.xlsx
noxinfluencer short-link export-effect <short_link_id> --output short-link-effect.xlsx
noxinfluencer affiliation stores list
noxinfluencer affiliation campaigns list --store-id <store_id>
noxinfluencer affiliation members add <campaign_id> --body-file affiliation-members.json --force
noxinfluencer affiliation members import-file <campaign_id> --file affiliation-members.xlsx --force
noxinfluencer feedback submit --message "Email reply count looks wrong" --category bug --file screenshot.png --force
noxinfluencer feedback inbox
noxinfluencer dispute records <creator_id>
noxinfluencer dispute report --body-file dispute-report.json --file evidence.jpg --force
noxinfluencer dispute mine --review_statuses '[1]'
noxinfluencer export get <export_id>
noxinfluencer export download <export_id> --output ./export.xlsx
noxinfluencer monitor history --task_id <task_id> --granularity daily --start_date 2026-03-20Creator Result Exports
Export selected search results with the encrypted IDs returned in data.items[].id:
{
"platform": "youtube",
"mode": "deep",
"creator_ids": ["<data.items[0].id>", "<data.items[1].id>"],
"field_keys": ["username", "kol_link", "followers"]
}noxinfluencer creator export-preview --body-file creator-export.json
noxinfluencer creator export --body-file creator-export.json --force
noxinfluencer export get <export_id>
noxinfluencer export download <export_id> --output ./creators.xlsxFor lookalikes, reuse the response data.export_context unchanged so the export reruns the same filters:
{
"mode": "base",
"creator_ids": ["<data.items[0].id>"],
"export_context": {
"source_creator_id": "<data.export_context.source_creator_id>",
"platform": "instagram",
"country": ["US"]
}
}noxinfluencer creator export-preview --body-file lookalikes-export.json
noxinfluencer creator lookalikes-export --body-file lookalikes-export.json --force
noxinfluencer export get <export_id>
noxinfluencer export download <export_id> --output ./lookalikes.xlsxAll selected IDs must match the export platform. Base mode uses the SaaS base columns; deep mode requires platform-supported field_keys. Contact fields such as email and whatsapp can consume contact quota and should only be requested for external outreach.
Run help for the full command list:
noxinfluencer --helpGlobal Options
--lang <code>- choose user-facing URLs and hints (zhusescn.noxinfluencer.com, others usewww.noxinfluencer.com)--json/--plain- switch output format--trace-json- emit structured request traces to stderr--dry-run- preview the request without executing it
Proxy Support
The CLI reads standard proxy environment variables and routes requests through undici with an explicit proxy dispatcher. NODE_USE_ENV_PROXY=1 is not required.
export HTTPS_PROXY=http://127.0.0.1:10808
export HTTP_PROXY=http://127.0.0.1:10808
export NO_PROXY=127.0.0.1,localhostNotes:
HTTPS_PROXYis used for online Skill API requestsHTTP_PROXYis used for local or non-TLS server URLsALL_PROXYis only used as a fallback when it is anhttp://orhttps://proxy URLsocks5://inALL_PROXYis not supported by the current CLI transport
Publish Checklist
Before publishing:
npm run pack:checkFor the first public release of this scoped package:
npm login
npm publish --access public