CLI: Management

This page is auto-generated. Do not edit directly. To update, modify the CLI source in pinner-cli and run pnpm generate:clil.

`point`

pinner point <name> [flags]

Point an onchain/decentralized domain at IPFS content via IPNS.

The command is idempotent. If an IPNS key for this domain already exists, it reuses the key and republishes the new CID.

 
pinner point vitalik.eth --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
 
pinner point vitalik.eth --cid bafybeig...updated

Flag	Alias	Description
`--cid`		CID to point the name at (required)

`unpoint`

pinner unpoint <name>

Remove the IPNS key for an onchain/decentralized domain. The domain will no longer resolve to IPFS content.

 
pinner unpoint vitalik.eth

`operations`

pinner operations

View and monitor account operations such as uploads, pins, and other processing tasks.

Operations track server-side processing of your requests. Each operation has a status: - pending

Operation is queued - running
Operation is in progress - completed - Operation finished successfully - failed
Operation failed - error
Operation encountered an error

 
pinner operations list
 
pinner operations list --status running
 
pinner operations list --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --limit 20
 
pinner operations get 42
 
pinner operations get 42 --watch

Subcommands:

Subcommand	Description
`list`	List your account operations with optional filtering. Operations track server-side processing of your requests (uploads, pins, etc.).
`get`	Get detailed information about a specific operation.

`list`

pinner operations list [flags]

List your account operations with optional filtering. Operations track server-side processing of your requests (uploads, pins, etc.).

 
pinner operations list
 
pinner operations list --status running
 
pinner operations list --operation upload
 
pinner operations list --protocol ipfs
 
pinner operations list --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
 
pinner operations list --limit 20
 
pinner operations list --watch

Flag	Alias	Description
`--status`		Filter by status (pending, running, completed, failed, error)
`--operation`		Filter by operation type (e.g., upload, pin)
`--protocol`		Filter by protocol (e.g., ipfs)
`--cid`		Filter by CID
`--limit`		Maximum number of results to return
`--watch`		Continuously monitor and update pin status (useful for watching uploads)

`get`

pinner operations get <operation-id> [flags]

Get detailed information about a specific operation.

 
pinner operations get 42
 
pinner operations get 42 --watch

Flag	Alias	Description
`--watch`		Wait for the operation to complete

`dns`

pinner dns

Manage DNS zones and records for your domains. DNS hosting allows you to control DNS configuration for IPFS-hosted websites.

Zone operations:

List all DNS zones
Create a new DNS zone
Get zone details
Delete a DNS zone

Record operations:

List DNS records for a zone
Create DNS records
Get record details
Update DNS records
Delete DNS records

 
pinner dns zones list
 
pinner dns zones create --domain example.com
 
pinner dns zones get example.com
 
pinner dns zones delete example.com
 
pinner dns records list example.com
 
pinner dns records create example.com --name www --type CNAME --content example.com
 
pinner dns records delete example.com --name www --type CNAME

Subcommands:

Subcommand	Description
`zones`	Manage DNS zones for your domains.
`records`	Manage DNS records for zones.

`zones`

pinner dns zones

Manage DNS zones for your domains.

 
pinner dns zones list
 
pinner dns zones list --status active
 
pinner dns zones create --domain example.com
 
pinner dns zones create --domain example.com --nameservers ns1.example.com,ns2.example.com
 
pinner dns zones get example.com
 
pinner dns zones delete example.com

Subcommands:

Subcommand	Description
`list`	List all DNS zones for the authenticated user.
`create`	Create a new DNS zone for a domain.
`get`	Get details of a specific DNS zone.
`delete`	Delete a DNS zone and all its records.
`validate`	Validate that a DNS zone's nameservers are properly delegated. This checks that the domain's nameservers point to the expected Pinner.xyz nameservers.

`list`

pinner dns zones list

List all DNS zones for the authenticated user.

 
pinner dns zones list
 
pinner dns zones list --json

`create`

pinner dns zones create [flags]

Create a new DNS zone for a domain.

 
pinner dns zones create --domain example.com
 
pinner dns zones create --domain example.com --nameservers ns1.example.com,ns2.example.com
 
pinner dns zones create --domain example.com --json

Flag	Alias	Description
`--domain`		Domain name for the website (required)
`--nameservers`		Comma-separated list of nameservers (e.g., ns1.example.com,ns2.example.com)

`get`

pinner dns zones get <domain>

Get details of a specific DNS zone.

 
pinner dns zones get example.com
 
pinner dns zones get example.com --json

`delete`

pinner dns zones delete <domain>

Delete a DNS zone and all its records.

 
pinner dns zones delete example.com

`validate`

pinner dns zones validate <domain>

Validate that a DNS zone's nameservers are properly delegated. This checks that the domain's nameservers point to the expected Pinner.xyz nameservers.

 
pinner dns zones validate example.com
 
pinner dns zones validate example.com --json

`records`

pinner dns records

Manage DNS records for zones.

 
pinner dns records list example.com
 
pinner dns records create example.com --name www --type CNAME --content example.com
 
pinner dns records get example.com --name www --type CNAME
 
pinner dns records update example.com --name www --type CNAME --content new.example.com
 
pinner dns records delete example.com --name www --type CNAME

Subcommands:

Subcommand	Description
`list`	List all DNS records for a specific zone.
`create`	Create a DNS record in the specified zone.
`get`	Get details of a specific DNS record.
`update`	Update an existing DNS record.
`delete`	Delete a DNS record from a zone.

`list`

pinner dns records list <domain>

List all DNS records for a specific zone.

 
pinner dns records list example.com
 
pinner dns records list example.com --json

`create`

pinner dns records create <domain> [flags]

Create a DNS record in the specified zone.

 
pinner dns records create example.com --name www --type CNAME --content example.com
 
pinner dns records create example.com --name _dnslink --type TXT --content "/ipfs/bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e" --ttl 3600
 
pinner dns records create example.com --name @ --type A --content 192.168.1.1 --json

Flag	Alias	Description
`--name`		DNS record name
`--type`		DNS record type (A, AAAA, CNAME, TXT, MX, NS, etc.)
`--content`		DNS record content
`--ttl`		DNS record TTL in seconds (default: 3600)
`--disabled`		Disable the DNS record

`get`

pinner dns records get <domain> [flags]

Get details of a specific DNS record.

 
pinner dns records get example.com --name www --type CNAME
 
pinner dns records get example.com --name www --type CNAME --json

Flag	Alias	Description
`--name`		DNS record name (required)
`--type`		DNS record type (A, AAAA, CNAME, TXT, MX, NS, etc.) (required)

`update`

pinner dns records update <domain> [flags]

Update an existing DNS record.

 
pinner dns records update example.com --name www --type CNAME --content new.example.com
 
pinner dns records update example.com --name www --type CNAME --content new.example.com --ttl 7200
 
pinner dns records update example.com --name www --type CNAME --json

Flag	Alias	Description
`--name`		DNS record name (required)
`--type`		DNS record type (A, AAAA, CNAME, TXT, MX, NS, etc.) (required)
`--content`		DNS record content
`--ttl`		DNS record TTL in seconds (default: 3600)
`--disabled`		Disable the DNS record

`delete`

pinner dns records delete <domain> [flags]

Delete a DNS record from a zone.

 
pinner dns records delete example.com --name www --type CNAME

Flag	Alias	Description
`--name`		DNS record name (required)
`--type`		DNS record type (A, AAAA, CNAME, TXT, MX, NS, etc.) (required)

`ipns`

pinner ipns

IPNS provides a mutable address scheme for IPFS content, allowing you to publish content under a stable name that you can update to point to new CIDs.

IPNS operations include:

Managing IPNS keys (create, list, get, delete)
Publishing CIDs to IPNS names
Republishing IPNS records
Resolving IPNS names to their target CIDs

Key names and numeric IDs are interchangeable. For example: pinner ipns keys get my-key is equivalent to:

pinner ipns keys get 1

 
pinner ipns keys list
 
pinner ipns keys create my-key
 
pinner ipns keys get my-key
 
pinner ipns keys delete my-key
 
pinner ipns publish bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --key-name my-key
 
pinner ipns republish my-key
 
pinner ipns resolve k51qzi5uqu5djx

Subcommands:

Subcommand	Description
`keys`	Manage your IPNS keys. Keys are used to publish content under stable IPNS names that you can update to point to new CIDs.
`publish`	Publish a CID to an IPNS key, making it resolvable via the IPNS name. After publishing, the IPNS name will resolve to the specified CID.
`republish`	Republish the IPNS record for a specific key. This refreshes the record on the network, extending its validity.
`resolve`	Resolve an IPNS name to its target CID. This shows which content the IPNS name currently points to.

`keys`

pinner ipns keys

Manage your IPNS keys. Keys are used to publish content under stable IPNS names that you can update to point to new CIDs.

Key names and numeric IDs are interchangeable.

 
pinner ipns keys list
 
pinner ipns keys create my-key
 
pinner ipns keys get my-key
 
pinner ipns keys delete my-key

Subcommands:

Subcommand	Description
`list`	List all IPNS keys for the authenticated user.
`create`	Create a new IPNS key with the given name. Use the key to publish content under a stable IPNS name.
`get`	Get details of a specific IPNS key by its name or ID.
`delete`	Delete an IPNS key by its name or ID. This operation is irreversible.

`list`

pinner ipns keys list

List all IPNS keys for the authenticated user.

 
pinner ipns keys list
 
pinner ipns keys list --json

`create`

pinner ipns keys create <name> [flags]

Create a new IPNS key with the given name. Use the key to publish content under a stable IPNS name.

 
pinner ipns keys create my-key
 
pinner ipns keys create my-key --key `<private-key>`
 
pinner ipns keys create my-key --json

Flag	Alias	Description
`--key`		Private key to import (optional, generates a new key if not provided)

`get`

pinner ipns keys get <key-name-or-id>

Get details of a specific IPNS key by its name or ID.

 
pinner ipns keys get my-key
 
pinner ipns keys get 1
 
pinner ipns keys get my-key --json

`delete`

pinner ipns keys delete <key-name-or-id>

Delete an IPNS key by its name or ID. This operation is irreversible.

 
pinner ipns keys delete my-key
 
pinner ipns keys delete 1

`publish`

pinner ipns publish <cid> [flags]

Publish a CID to an IPNS key, making it resolvable via the IPNS name. After publishing, the IPNS name will resolve to the specified CID.

Specify the key by name or numeric ID.

 
pinner ipns publish bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --key-name my-key
 
pinner ipns publish bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --key-name my-key --ttl 24h
 
pinner ipns publish bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --key-name 1 --json

Flag	Alias	Description
`--key-name`		Name or ID of the IPNS key to publish to (required)
`--ttl`		Time-to-live for the IPNS record (e.g., 24h, 7d)
`--wait`		Wait for the pinning operation to complete before returning

`republish`

pinner ipns republish <key-name-or-id>

Republish the IPNS record for a specific key. This refreshes the record on the network, extending its validity.

Specify the key by name or numeric ID.

 
pinner ipns republish my-key
 
pinner ipns republish 1
 
pinner ipns republish my-key --json

`resolve`

pinner ipns resolve <name>

Resolve an IPNS name to its target CID. This shows which content the IPNS name currently points to.

 
pinner ipns resolve k51qzi5uqu5djx...
 
pinner ipns resolve k51qzi5uqu5djx... --json

`websites`

pinner websites

Manage websites for your IPFS content. Websites allow you to associate domain names with CIDs, making your content accessible through custom domains.

Website operations include:

List all websites
Create a new website
Get website details
Update website configuration
Delete a website
Validate website configuration

 
pinner websites list
 
pinner websites create example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
 
pinner websites get example.com
 
pinner websites update example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
 
pinner websites delete example.com
 
pinner websites validate example.com

Subcommands:

Subcommand	Description
`list`	List all websites for the authenticated user.
`create`	Create a new website with the specified domain and target CID.
`get`	Get details of a specific website by domain.
`update`	Update an existing website with new CID, target type, or domain rename.
`enable-ipns`	Convert a website from IPFS to IPNS targeting.
`delete`	Delete a website by domain. This operation is irreversible.
`validate`	Validate a website by domain to check if DNS is properly configured.
`ssl`	View SSL certificate status for your websites.
`config`	Show the website hosting configuration including the gateway domain.
`wizard`	Launch an interactive wizard to create a new website step by step.

`list`

pinner websites list

List all websites for the authenticated user.

 
pinner websites list
 
pinner websites list --json

`create`

pinner websites create <domain> [flags]

Create a new website with the specified domain and target CID.

 
pinner websites create example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
 
pinner websites create example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --target-type ipfs
 
pinner websites create example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --dns-hosting
 
pinner websites create example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --json

Flag	Alias	Description
`--cid`		CID for the website (required)
`--target-type`		Target type (ipfs, ipns, etc.)
`--dns-hosting`		Enable DNS hosting for this website
`--no-dns-hosting`		Disable DNS hosting for this website

`get`

pinner websites get <domain>

Get details of a specific website by domain.

 
pinner websites get example.com
 
pinner websites get example.com --json

`update`

pinner websites update <domain> [flags]

Update an existing website with new CID, target type, or domain rename.

At least one of the optional fields must be provided to update the website.

When --target-type is set to "ipns" without --cid, the website will be converted from IPFS to IPNS targeting (an IPNS key is auto-created and the current CID is published to it).

When --target-type is "ipns" and --cid is a regular IPFS CID (not a peer ID), an IPNS key is auto-created and that CID is published to it.

 
pinner websites update example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --target-type ipfs
 
pinner websites update example.com --target-type ipns
 
pinner websites update example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e --target-type ipns
 
pinner websites update example.com --dns-hosting
 
pinner websites update example.com --no-dns-hosting
 
pinner websites update example.com --json

Flag	Alias	Description
`--domain`		Domain name for the website
`--cid`		CID for the website
`--target-type`		Target type (ipfs, ipns, etc.)
`--dns-hosting`		Enable DNS hosting for this website
`--no-dns-hosting`		Disable DNS hosting for this website

`enable-ipns`

pinner websites enable-ipns <domain> [flags]

Convert a website from IPFS to IPNS targeting.

An IPNS key will be auto-created and the current CID will be published to it. This enables content-addressed updates without changing the domain's DNS records.

If --cid is provided, the IPNS key will publish that CID instead of the current one.

 
pinner websites enable-ipns example.com
 
pinner websites enable-ipns example.com --cid bafybeigqaforwjgcx45jnh7dgyfgqqm2lei4hurrrnsizrpgyxz3egtd7e
 
pinner websites enable-ipns example.com --json

Flag	Alias	Description
`--cid`		CID for the website

`delete`

pinner websites delete <domain>

Delete a website by domain. This operation is irreversible.

 
pinner websites delete example.com
 
pinner websites delete example.com --json

`validate`

pinner websites validate <domain>

Validate a website by domain to check if DNS is properly configured.

 
pinner websites validate example.com
 
pinner websites validate example.com --json

`ssl`

pinner websites ssl

View SSL certificate status for your websites.

SSL operations include:

Check SSL certificate status for a domain
Monitor SSL status changes in real-time

 
pinner websites ssl status example.com
 
pinner websites ssl status example.com --json
 
pinner websites ssl status example.com --watch

Subcommands:

Subcommand	Description
`status`	Get SSL certificate status for a website domain.

`status`

pinner websites ssl status <domain> [flags]

Get SSL certificate status for a website domain.

This command retrieves the current SSL certificate status including:

Certificate status (active, pending, error, etc.)
Certificate issuance date
Last update timestamp
Any error messages

 
pinner websites ssl status example.com
 
pinner websites ssl status example.com --json
 
pinner websites ssl status example.com --watch

Flag	Alias	Description
`--watch`		Watch for SSL status changes

`config`

pinner websites config

Show the website hosting configuration including the gateway domain.

Use this to find the gateway domain for setting up CNAME records with your DNS provider.

 
pinner websites config
 
pinner websites config --json

`wizard`

pinner websites wizard

Launch an interactive wizard to create a new website step by step.

The wizard will guide you through:

Authentication check
Content source (CID or upload)
Target type (IPFS or IPNS)
Domain name
DNS mode (Pinner-managed or self-managed)
Website creation
DNS setup
Validation

 
pinner websites wizard