Skip to content

Client setup ​

Configure and publish commands for every client, for your own server URL and repository name. The snippets come from web/src/lib/installCommands.ts, the module behind the web UI's connect panel for a repository, so this page and the UI show the same commands. Credentials are always the placeholder <TOKEN>: create an API token as described in authentication.

Repository URL: https://artifacts.example.com/repos/my-repo

npm

Configure (create the token under Account → Tokens):

npm config set registry https://artifacts.example.com/repos/my-repo/
npm config set //artifacts.example.com/repos/my-repo/:_authToken <TOKEN>

Publish:

npm publish --registry https://artifacts.example.com/repos/my-repo/

pnpm

Configure (create the token under Account → Tokens):

pnpm config set registry https://artifacts.example.com/repos/my-repo/
pnpm config set //artifacts.example.com/repos/my-repo/:_authToken <TOKEN>

Publish:

pnpm publish --registry https://artifacts.example.com/repos/my-repo/

yarn

Configure (create the token under Account → Tokens):

yarn config set npmRegistryServer https://artifacts.example.com/repos/my-repo/
yarn config set npmAuthToken <TOKEN>

Publish:

yarn npm publish

On GitHub this page shows no snippets (they are rendered by the documentation site, https://openartifact.github.io/). Open a repository in the web UI to get the same commands, or read the per-format pages: format matrix.

Free software under the AGPL-3.0-or-later.