Skip to content

Install the Socifyr CLI ​

Install @socifyr/cli globally with your package manager, then run socifyr configure. The CLI needs Node.js 18 or newer.

How do I install the socifyr CLI? ​

bash
npm install -g @socifyr/cli
bash
pnpm add -g @socifyr/cli
bash
bun add -g @socifyr/cli
bash
yarn global add @socifyr/cli

The unscoped package socifyr is an alias that depends on @socifyr/cli and exposes the same socifyr binary. Verify the install:

bash
socifyr --version
# 0.3.0

How do I set my API key? ​

bash
socifyr configure --key sk_...

This writes ~/.socifyr/config.json. Details and flags are on the configure page. Create an API key in the dashboard; each key belongs to one workspace. See API keys.

Which settings does the CLI read, and in what order? ​

Environment variable first, then the config file, then the built-in default.

SettingEnv varConfig key
API keySOCIFYR_API_KEYapiKey
API URLSOCIFYR_API_URLapiUrl (default https://api.socifyr.com/api)

How do I publish a first post from the CLI? ​

bash
socifyr connections
socifyr post "Hello from the CLI" --to linkedin-myhandle --wait

Global flags ​

FlagDescription
-h, --helpShow help for the CLI or a command
-V, --versionPrint the CLI version

--json is a per-command flag, not a global one. See the CLI overview for the command list and exit codes.

Next steps ​