Artifact Share

Artifact Share CLI reference

CLI version: @artifactshare/cli 0.11.3 · Generated: 2026-08-25

A public, machine-friendly guide to sharing, updating, reading, and organizing artifacts from a terminal.

Introduction and authentication

Node.js 22.19 or newer is required. Start with the init command shown above, complete browser sign-in, or import a token for CI with profiles import-token. Use login --preset agent to restrict an agent to one selected project. A new profile defaults to unrestricted access; an existing profile keeps its previous preset. Use --profile to keep credentials separate, logout to revoke a browser-authenticated CLI session, and Settings → Tokens to revoke an API token.

Usage

npx --yes @artifactshare/cli [COMMANDS] <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

Basic operations

Use share for a file, folder, or static site; update to keep the same URL; open or artifacts get to read; download to save locally; comments for review; projects for organization; profiles and config for accounts and settings; and skills for agent setup.

Command reference

The command surface below is generated from the public CLI help. Usage and accepted options are rendered from the generated surface snapshot.

All public commands

append

Append a local UTF-8 file to an existing single-file HTML or Markdown artifact.

Example
npx --yes @artifactshare/cli append <artifact-id-or-url> ./section.md --json

Usage

npx --yes @artifactshare/cli append <OPTIONS> <artifactIdOrUrl> <path>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

artifacts

Browse and read artifacts.

Usage

npx --yes @artifactshare/cli artifacts [COMMANDS] <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

artifacts get

Read an artifact and its metadata.

Usage

npx --yes @artifactshare/cli artifacts get <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --offset · --include

artifacts list

List artifacts you can access, including project or home results.

Usage

npx --yes @artifactshare/cli artifacts list <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --project-id · --home · --query · --cursor

changelog

Show CLI release notes.

Usage

npx --yes @artifactshare/cli changelog <OPTIONS>

Options

--help · --version · --json

comments

Work with comments on an artifact.

Usage

npx --yes @artifactshare/cli comments [COMMANDS] <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

comments delete

Delete a comment message.

Usage

npx --yes @artifactshare/cli comments delete <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --thread-id · --message-id

comments edit

Edit a comment message.

Usage

npx --yes @artifactshare/cli comments edit <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --message-id · --body

comments list

List comment threads and messages.

Usage

npx --yes @artifactshare/cli comments list <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

comments post

Post a comment, reply, or quoted comment.

Usage

npx --yes @artifactshare/cli comments post <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --body · --reply-to · --quote · --quote-before · --quote-after · --agent

comments reopen

Reopen a resolved comment thread.

Usage

npx --yes @artifactshare/cli comments reopen <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --thread-id

comments resolve

Resolve a comment thread.

Usage

npx --yes @artifactshare/cli comments resolve <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --thread-id

config

Inspect and change local CLI settings.

Usage

npx --yes @artifactshare/cli config [COMMANDS] <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

config get

Read a setting at user, repository, or effective scope.

Example
npx --yes @artifactshare/cli config get home_audience --scope effective --json

Usage

npx --yes @artifactshare/cli config get <OPTIONS> [<key>]

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --scope

config set

Save a setting at user or repository scope.

Example
npx --yes @artifactshare/cli config set home_audience private --scope user --json

Usage

npx --yes @artifactshare/cli config set <OPTIONS> <key> <value>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --scope

config unset

Remove a setting at user or repository scope.

Usage

npx --yes @artifactshare/cli config unset <OPTIONS> <key>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --scope

delete

Permanently delete an artifact.

Usage

npx --yes @artifactshare/cli delete <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

doctor

Check token storage, authentication, configuration, and connectivity.

Usage

npx --yes @artifactshare/cli doctor <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

download

Download an artifact to a local path.

Usage

npx --yes @artifactshare/cli download <OPTIONS> [<artifactIdOrUrl>]

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --project-id · --output · --force

edit

Edit artifact title, visibility, grants, or destination.

Usage

npx --yes @artifactshare/cli edit <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --title · --visibility · --link-expires-at · --no-link-expiry · --grant-email · --revoke-email · --project-id · --home

init

Detect the agent, install its skill, and start setup.

Example
npx --yes @artifactshare/cli init --json

Usage

npx --yes @artifactshare/cli init <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --project-id · --dry-run

login

Authorize the CLI with unrestricted or project-scoped agent access.

Example
npx --yes @artifactshare/cli login --profile agent --preset agent --json

Usage

npx --yes @artifactshare/cli login <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --preset · --project

logout

Revoke and remove a saved credential.

Usage

npx --yes @artifactshare/cli logout <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

move

Move an artifact to a project or home.

Usage

npx --yes @artifactshare/cli move <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --project-id · --home

open

Read an Artifact Share URL and prepare the CLI skill when needed.

Example
npx --yes @artifactshare/cli open <artifact-id-or-url> --json

Usage

npx --yes @artifactshare/cli open <OPTIONS> <artifactIdOrUrl>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

profiles

Manage named authentication profiles.

Usage

npx --yes @artifactshare/cli profiles [COMMANDS] <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

profiles delete

Delete a named profile.

Usage

npx --yes @artifactshare/cli profiles delete <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

profiles import-token

Import a CI or manually issued token into a profile.

Example
printf '%s' "$ARTIFACTSHARE_TOKEN" | npx --yes @artifactshare/cli profiles import-token --profile ci --json

Usage

npx --yes @artifactshare/cli profiles import-token <OPTIONS>

Options

--help · --version · --json · --base-url · --profile · --allow-plaintext-token-store · --insecure-localhost · --force

profiles list

List saved profiles.

Usage

npx --yes @artifactshare/cli profiles list <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

profiles use

Select the active profile.

Usage

npx --yes @artifactshare/cli profiles use <OPTIONS> <name>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

projects

Manage projects.

Usage

npx --yes @artifactshare/cli projects [COMMANDS] <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

projects create

Create a project.

Usage

npx --yes @artifactshare/cli projects create <OPTIONS> <name>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --description · --visibility

projects edit

Edit project details, audience, or archive state.

Usage

npx --yes @artifactshare/cli projects edit <OPTIONS> <id>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --name · --description · --visibility · --add-email · --remove-email · --archive · --unarchive

projects list

List projects available to you.

Usage

npx --yes @artifactshare/cli projects list <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

resolve

Resolve a URL, ID, or other Artifact Share value.

Usage

npx --yes @artifactshare/cli resolve <OPTIONS> <value>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

share

Share a local file, folder, or static site.

Example
npx --yes @artifactshare/cli share ./report.html --json

Usage

npx --yes @artifactshare/cli share <OPTIONS> <path>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --project-id · --project · --home · --visibility · --link-expires-at · --no-link-expiry · --no-slack-notify · --grant-email · --key

skills

Manage the installed Artifact Share agent skill.

Usage

npx --yes @artifactshare/cli skills [COMMANDS] <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

skills ensure

Ensure the skill is installed for a detected tool.

Usage

npx --yes @artifactshare/cli skills ensure <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --tool · --scope · --dry-run

skills install

Install the skill for a selected tool.

Usage

npx --yes @artifactshare/cli skills install <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --tool · --scope · --dry-run · --force

skills list

List installed skill targets.

Usage

npx --yes @artifactshare/cli skills list <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

skills remove

Remove an installed skill.

Usage

npx --yes @artifactshare/cli skills remove <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --tool · --scope · --dry-run

skills update

Update an installed skill.

Usage

npx --yes @artifactshare/cli skills update <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --tool · --scope · --dry-run · --force

update

Upload a new version behind an existing share URL.

Example
npx --yes @artifactshare/cli update <artifact-id-or-url> ./report.html --json

Usage

npx --yes @artifactshare/cli update <OPTIONS> <artifactIdOrUrl> <path>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

whoami

Show the active account and workspace.

Usage

npx --yes @artifactshare/cli whoami <OPTIONS>

Options

--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost

JSON output and exit codes

With --json, piping, or another non-interactive invocation, successful results go to stdout as a common envelope with schema_version: 2, ok: true, command, and data. Failures go to stderr with schema_version: 2, ok: false, command, and error. Exit code 0 means success, 1 means a command failure, and 130 means cancellation. An auth_required response includes the verification URL and user code; approve it, then rerun the same command.

Projects, home, audience, and settings

A project destination uses the project audience. When share has no destination, it posts to home. Choose home_audience by purpose: use user scope for a personal safe default in this CLI environment, repository scope only for a policy agreed by all participants, and explicit --visibility for one post. Confirm the result with config get home_audience --scope effective --json. home_audience is the canonical setting: private means only you, and workspace means everyone in the workspace. Store repository settings in .artifactshare/config.json and user settings in the user config directory. Home resolution checks repository home_audience, repository default_artifact_visibility, user home_audience, user default_artifact_visibility, then the product default workspace. default_artifact_visibility is only a compatibility alias. default_project_visibility is an independent default for projects create. --grant-email adds an individual project share recipient; it does not implicitly change project visibility.

Failures and recovery

For auth_required or token_invalid, run login or import a valid profile token and rerun the same command. For validation_failed, check usage and options. For target_not_found, resolve the URL or ID again. For upload_not_allowed, contact Artifact Share support. For network_failed, check the base URL and retry without changing the destination.

Create an API token for non-interactive use

If you use the CLI in CI or another environment without browser sign-in, create an API token.

Create an API token

Use the connect guide to choose an integration, the Share with AI guide to learn how to ask an agent, the updates page for product changes, and the npm package page for installation details.