From d8b257cda6283f834a38d01de7ea1dbcd488d0d9 Mon Sep 17 00:00:00 2001 From: Daniel N <2color@users.noreply.github.com> Date: Thu, 11 Dec 2025 14:08:37 +0100 Subject: [PATCH] chore: document default values for ipfs add flags --- core/commands/add.go | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/core/commands/add.go b/core/commands/add.go index cb4bcb312..56c867b50 100644 --- a/core/commands/add.go +++ b/core/commands/add.go @@ -206,38 +206,38 @@ https://github.com/ipfs/kubo/blob/master/docs/config.md#import cmds.OptionIgnore, cmds.OptionIgnoreRules, // Output Control - cmds.BoolOption(quietOptionName, "q", "Write minimal output."), - cmds.BoolOption(quieterOptionName, "Q", "Write only final hash."), - cmds.BoolOption(silentOptionName, "Write no output."), - cmds.BoolOption(progressOptionName, "p", "Stream progress data."), + cmds.BoolOption(quietOptionName, "q", "Write minimal output. Default: false"), + cmds.BoolOption(quieterOptionName, "Q", "Write only final hash. Default: false"), + cmds.BoolOption(silentOptionName, "Write no output. Default: false"), + cmds.BoolOption(progressOptionName, "p", "Stream progress data. Default: true (unless quiet or silent is enabled)"), // Basic Add Behavior - cmds.BoolOption(onlyHashOptionName, "n", "Only chunk and hash - do not write to disk."), - cmds.BoolOption(wrapOptionName, "w", "Wrap files with a directory object."), - cmds.BoolOption(pinOptionName, "Pin locally to protect added files from garbage collection.").WithDefault(true), - cmds.StringOption(pinNameOptionName, "Name to use for the pin. Requires explicit value (e.g., --pin-name=myname)."), + cmds.BoolOption(onlyHashOptionName, "n", "Only chunk and hash - do not write to disk. Default: false"), + cmds.BoolOption(wrapOptionName, "w", "Wrap files with a directory object. Default: false"), + cmds.BoolOption(pinOptionName, "Pin locally to protect added files from garbage collection. Default: true").WithDefault(true), + cmds.StringOption(pinNameOptionName, "Name to use for the pin. Requires explicit value (e.g., --pin-name=myname). Default: \"\" (only used when explicitly provided)"), // MFS Integration - cmds.StringOption(toFilesOptionName, "Add reference to Files API (MFS) at the provided path."), + cmds.StringOption(toFilesOptionName, "Add reference to Files API (MFS) at the provided path. Default: \"\" (disabled)"), // CID & Hashing cmds.IntOption(cidVersionOptionName, "CID version (0 or 1). CIDv1 automatically enables raw-leaves and is required for non-sha2-256 hashes. Default: Import.CidVersion"), cmds.StringOption(hashOptionName, "Hash function to use. Implies CIDv1 if not sha2-256. Default: Import.HashFunction"), - cmds.BoolOption(rawLeavesOptionName, "Use raw blocks for leaf nodes. Note: CIDv1 automatically enables raw-leaves. Default: false for CIDv0, true for CIDv1 (Import.UnixFSRawLeaves)"), + cmds.BoolOption(rawLeavesOptionName, "Use raw blocks for leaf nodes. Note: CIDv1 automatically enables raw-leaves. Default: Import.UnixFSRawLeaves"), // Chunking & DAG Structure cmds.StringOption(chunkerOptionName, "s", "Chunking algorithm, size-[bytes], rabin-[min]-[avg]-[max] or buzhash. Files larger than chunk size are split into multiple blocks. Default: Import.UnixFSChunker"), - cmds.BoolOption(trickleOptionName, "t", "Use trickle-dag format for dag generation."), + cmds.BoolOption(trickleOptionName, "t", "Use trickle-dag format for dag generation. Default: false"), // Advanced UnixFS Limits cmds.IntOption(maxFileLinksOptionName, "Limit the maximum number of links in UnixFS file nodes to this value. WARNING: experimental. Default: Import.UnixFSFileMaxLinks"), cmds.IntOption(maxDirectoryLinksOptionName, "Limit the maximum number of links in UnixFS basic directory nodes to this value. WARNING: experimental, Import.UnixFSHAMTDirectorySizeThreshold is safer. Default: Import.UnixFSDirectoryMaxLinks"), cmds.IntOption(maxHAMTFanoutOptionName, "Limit the maximum number of links of a UnixFS HAMT directory node to this (power of 2, multiple of 8). WARNING: experimental, Import.UnixFSHAMTDirectorySizeThreshold is safer. Default: Import.UnixFSHAMTDirectoryMaxFanout"), // Experimental Features - cmds.BoolOption(inlineOptionName, "Inline small blocks into CIDs. WARNING: experimental"), - cmds.IntOption(inlineLimitOptionName, fmt.Sprintf("Maximum block size to inline. Maximum: %d bytes. WARNING: experimental", verifcid.DefaultMaxIdentityDigestSize)).WithDefault(32), - cmds.BoolOption(noCopyOptionName, "Add the file using filestore. Implies raw-leaves. WARNING: experimental"), - cmds.BoolOption(fstoreCacheOptionName, "Check the filestore for pre-existing blocks. WARNING: experimental"), - cmds.BoolOption(preserveModeOptionName, "Apply existing POSIX permissions to created UnixFS entries. WARNING: experimental, forces dag-pb for root block, disables raw-leaves"), - cmds.BoolOption(preserveMtimeOptionName, "Apply existing POSIX modification time to created UnixFS entries. WARNING: experimental, forces dag-pb for root block, disables raw-leaves"), - cmds.UintOption(modeOptionName, "Custom POSIX file mode to store in created UnixFS entries. WARNING: experimental, forces dag-pb for root block, disables raw-leaves"), - cmds.Int64Option(mtimeOptionName, "Custom POSIX modification time to store in created UnixFS entries (seconds before or after the Unix Epoch). WARNING: experimental, forces dag-pb for root block, disables raw-leaves"), - cmds.UintOption(mtimeNsecsOptionName, "Custom POSIX modification time (optional time fraction in nanoseconds)"), + cmds.BoolOption(inlineOptionName, "Inline small blocks into CIDs. WARNING: experimental. Default: false"), + cmds.IntOption(inlineLimitOptionName, fmt.Sprintf("Maximum block size to inline. Maximum: %d bytes. WARNING: experimental. Default: 32", verifcid.DefaultMaxIdentityDigestSize)).WithDefault(32), + cmds.BoolOption(noCopyOptionName, "Add the file using filestore. Implies raw-leaves. WARNING: experimental. Default: false"), + cmds.BoolOption(fstoreCacheOptionName, "Check the filestore for pre-existing blocks. WARNING: experimental. Default: false"), + cmds.BoolOption(preserveModeOptionName, "Apply existing POSIX permissions to created UnixFS entries. WARNING: experimental, forces dag-pb for root block, disables raw-leaves. Default: false"), + cmds.BoolOption(preserveMtimeOptionName, "Apply existing POSIX modification time to created UnixFS entries. WARNING: experimental, forces dag-pb for root block, disables raw-leaves. Default: false"), + cmds.UintOption(modeOptionName, "Custom POSIX file mode to store in created UnixFS entries. WARNING: experimental, forces dag-pb for root block, disables raw-leaves. Default: 0 (not set)"), + cmds.Int64Option(mtimeOptionName, "Custom POSIX modification time to store in created UnixFS entries (seconds before or after the Unix Epoch). WARNING: experimental, forces dag-pb for root block, disables raw-leaves. Default: 0 (not set)"), + cmds.UintOption(mtimeNsecsOptionName, "Custom POSIX modification time (optional time fraction in nanoseconds). Default: 0 (not set)"), cmds.BoolOption(fastProvideRootOptionName, "Immediately provide root CID to DHT in addition to regular queue, for faster discovery. Default: Import.FastProvideRoot"), cmds.BoolOption(fastProvideWaitOptionName, "Block until the immediate provide completes before returning. Default: Import.FastProvideWait"), },