artifacts
Browse and read artifacts.
Usage
artifactshare artifacts [COMMANDS] <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
Artifact Share CLI reference
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 npx --yes @artifactshare/cli init, complete the browser device login, or import a restricted token for CI with profiles import-token. Use --profile to keep accounts separate.
Usage
artifactshare [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
artifacts get
Read an artifact and its metadata.
Usage
artifactshare 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
artifactshare artifacts list <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --project-id · --home · --query
changelog
Show CLI release notes.
Usage
artifactshare changelog <OPTIONS>Options
--help · --version · --json
comments
Work with comments on an artifact.
Usage
artifactshare comments [COMMANDS] <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
comments delete
Delete a comment message.
Usage
artifactshare 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
artifactshare 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
artifactshare 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
artifactshare 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
artifactshare 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
artifactshare 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
artifactshare 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 --jsonUsage
artifactshare 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 --jsonUsage
artifactshare 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
artifactshare 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
artifactshare delete <OPTIONS> <artifactIdOrUrl>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
doctor
Check authentication, configuration, and connectivity.
Usage
artifactshare 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
artifactshare download <OPTIONS> <artifactIdOrUrl>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --output · --force
edit
Edit artifact title, visibility, grants, or destination.
Usage
artifactshare edit <OPTIONS> <artifactIdOrUrl>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --title · --visibility · --grant-email · --revoke-email · --project-id · --home
init
Detect the agent, install its skill, and start setup.
Example
npx --yes @artifactshare/cli init --jsonUsage
artifactshare 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 a browser device login.
Example
npx --yes @artifactshare/cli login --jsonUsage
artifactshare login <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
logout
Remove a saved local credential.
Usage
artifactshare 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
artifactshare 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> --jsonUsage
artifactshare open <OPTIONS> <artifactIdOrUrl>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
profiles
Manage named authentication profiles.
Usage
artifactshare profiles [COMMANDS] <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
profiles delete
Delete a named profile.
Usage
artifactshare 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 --jsonUsage
artifactshare profiles import-token <OPTIONS>Options
--help · --version · --json · --base-url · --profile · --allow-plaintext-token-store · --insecure-localhost
profiles list
List saved profiles.
Usage
artifactshare profiles list <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
profiles use
Select the active profile.
Usage
artifactshare profiles use <OPTIONS> <name>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
projects
Manage projects.
Usage
artifactshare projects [COMMANDS] <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
projects create
Create a project.
Usage
artifactshare 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
artifactshare 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
artifactshare projects list <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
request-access
Request upload access when a workspace gates uploads.
Usage
artifactshare request-access <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --note
resolve
Resolve a URL, ID, or other Artifact Share value.
Usage
artifactshare 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 --jsonUsage
artifactshare share <OPTIONS> <path>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost · --project-id · --project · --home · --visibility · --grant-email · --key
skills
Manage the installed Artifact Share agent skill.
Usage
artifactshare 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
artifactshare 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
artifactshare 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
artifactshare skills list <OPTIONS>Options
--help · --version · --json · --base-url · --token · --profile · --allow-plaintext-token-store · --insecure-localhost
skills remove
Remove an installed skill.
Usage
artifactshare 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
artifactshare 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 --jsonUsage
artifactshare 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
artifactshare 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, request access. For network_failed, check the base URL and retry without changing the destination.