[{"data":1,"prerenderedAt":931},["ShallowReactive",2],{"docs-nav":3,"content-query-qwEGvxjtTA":265},[4,8,11,14,17,21,25,29,32,36,40,44,48,52,56,60,63,67,71,75,79,83,87,91,95,99,103,107,111,115,118,121,124,127,130,133,136,139,142,145,148,151,154,157,160,163,166,169,172,175,178,181,184,187,190,193,196,199,202,205,208,211,214,217,220,223,226,229,232,235,238,241,244,247,250,253,256,259,262],{"_path":5,"title":6,"order":7},"/docs/getting-started","Getting Started",1,{"_path":9,"title":10,"order":7},"/docs/views/grid","Grid View",{"_path":12,"title":13,"order":7},"/docs/api/server","Server API",{"_path":15,"title":16,"order":7},"/docs/self-hosting/all-in-one","All-in-One Setup",{"_path":18,"title":19,"order":20},"/docs/core-concepts","Core Concepts",10,{"_path":22,"title":23,"order":24},"/docs/crdt","What is a CRDT?",11,{"_path":26,"title":27,"order":28},"/docs/api/client-http","Client HTTP API",2,{"_path":30,"title":31,"order":28},"/docs/self-hosting/separate-containers","Separate Containers Setup",{"_path":33,"title":34,"order":35},"/docs/interface-overview","Interface Overview",20,{"_path":37,"title":38,"order":39},"/docs/global-search","Global Search",22,{"_path":41,"title":42,"order":43},"/docs/filters","Filters",24,{"_path":45,"title":46,"order":47},"/docs/sorting","Sorting",25,{"_path":49,"title":50,"order":51},"/docs/tagging-and-selection","Tagging & Selection",26,{"_path":53,"title":54,"order":55},"/docs/quick-view","Quick View",28,{"_path":57,"title":58,"order":59},"/docs/api/cli","CLI",3,{"_path":61,"title":62,"order":59},"/docs/self-hosting/remote-access-tailscale","Remote Access with Tailscale",{"_path":64,"title":65,"order":66},"/docs/block-actions","Block Actions",30,{"_path":68,"title":69,"order":70},"/docs/deleting-blocks","Deleting Blocks & Trash",32,{"_path":72,"title":73,"order":74},"/docs/self-hosting","Self-Hosting",4,{"_path":76,"title":77,"order":78},"/docs/managing-heaps","Managing Heaps",40,{"_path":80,"title":81,"order":82},"/docs/file-scanning","File Scanning & Importing",42,{"_path":84,"title":85,"order":86},"/docs/storage-management","Storage Management",44,{"_path":88,"title":89,"order":90},"/docs/daily-notes","Daily Notes & Calendar",46,{"_path":92,"title":93,"order":94},"/docs/api","API",5,{"_path":96,"title":97,"order":98},"/docs/views","Views",60,{"_path":100,"title":101,"order":102},"/docs/authentication","Authentication & User Management",70,{"_path":104,"title":105,"order":106},"/docs/licenses-privacy","Licenses & Privacy",72,{"_path":108,"title":109,"order":110},"/docs/faq","FAQ",80,{"_path":112,"title":113,"order":114},"/docs/changelog","Changelog",99,{"_path":116,"title":117},"/docs/changelog/v16.16.37","v16.16.37",{"_path":119,"title":120},"/docs/changelog/v16.16.38","v16.16.38",{"_path":122,"title":123},"/docs/changelog/v16.11.0","v16.11.0",{"_path":125,"title":126},"/docs/changelog/v16.16.29","v16.16.29",{"_path":128,"title":129},"/docs/changelog/v16.16.28","v16.16.28",{"_path":131,"title":132},"/docs/changelog/v16.16.1","v16.16.1",{"_path":134,"title":135},"/docs/changelog/v16.10.0","v16.10.0",{"_path":137,"title":138},"/docs/changelog/v16.16.8","v16.16.8",{"_path":140,"title":141},"/docs/changelog/v16.7.0","v16.7.0",{"_path":143,"title":144},"/docs/changelog/v16.16.14","v16.16.14",{"_path":146,"title":147},"/docs/changelog/v16.16.7","v16.16.7",{"_path":149,"title":150},"/docs/changelog/v16.16.36","v16.16.36",{"_path":152,"title":153},"/docs/changelog/v16.16.32","v16.16.32",{"_path":155,"title":156},"/docs/changelog/v16.16.41","v16.16.41",{"_path":158,"title":159},"/docs/changelog/v16.6.0","v16.6.0",{"_path":161,"title":162},"/docs/changelog/v16.16.4","v16.16.4",{"_path":164,"title":165},"/docs/changelog/v16.16.0","v16.16.0",{"_path":167,"title":168},"/docs/changelog/v16.16.40","v16.16.40",{"_path":170,"title":171},"/docs/changelog/v16.16.20","v16.16.20",{"_path":173,"title":174},"/docs/changelog/v16.16.16","v16.16.16",{"_path":176,"title":177},"/docs/changelog/v16.16.25","v16.16.25",{"_path":179,"title":180},"/docs/changelog/v16.16.17","v16.16.17",{"_path":182,"title":183},"/docs/changelog/v16.17.8","v16.17.8",{"_path":185,"title":186},"/docs/changelog/v16.16.33","v16.16.33",{"_path":188,"title":189},"/docs/changelog/v16.16.22","v16.16.22",{"_path":191,"title":192},"/docs/changelog/v16.16.23","v16.16.23",{"_path":194,"title":195},"/docs/changelog/v16.16.35","v16.16.35",{"_path":197,"title":198},"/docs/changelog/v16.16.24","v16.16.24",{"_path":200,"title":201},"/docs/changelog/v16.16.5","v16.16.5",{"_path":203,"title":204},"/docs/changelog/v16.16.11","v16.16.11",{"_path":206,"title":207},"/docs/changelog/v16.16.27","v16.16.27",{"_path":209,"title":210},"/docs/changelog/v16.16.19","v16.16.19",{"_path":212,"title":213},"/docs/changelog/v16.16.13","v16.16.13",{"_path":215,"title":216},"/docs/changelog/v16.16.3","v16.16.3",{"_path":218,"title":219},"/docs/changelog/v16.9.0","v16.9.0",{"_path":221,"title":222},"/docs/changelog/v16.16.43","v16.16.43",{"_path":224,"title":225},"/docs/changelog/v16.16.2","v16.16.2",{"_path":227,"title":228},"/docs/changelog/v16.16.18","v16.16.18",{"_path":230,"title":231},"/docs/changelog/v16.16.30","v16.16.30",{"_path":233,"title":234},"/docs/changelog/v16.16.21","v16.16.21",{"_path":236,"title":237},"/docs/changelog/v16.16.26","v16.16.26",{"_path":239,"title":240},"/docs/changelog/v16.16.6","v16.16.6",{"_path":242,"title":243},"/docs/changelog/v16.16.31","v16.16.31",{"_path":245,"title":246},"/docs/changelog/v16.16.39","v16.16.39",{"_path":248,"title":249},"/docs/changelog/v16.16.34","v16.16.34",{"_path":251,"title":252},"/docs/changelog/v16.16.12","v16.16.12",{"_path":254,"title":255},"/docs/changelog/v16.8.0","v16.8.0",{"_path":257,"title":258},"/docs/changelog/v16.16.10","v16.16.10",{"_path":260,"title":261},"/docs/changelog/v16.16.9","v16.16.9",{"_path":263,"title":264},"/docs/changelog/v16.16.15","v16.16.15",{"_path":266,"_dir":267,"_draft":268,"_partial":268,"_locale":269,"title":270,"description":271,"published":268,"body":272,"_type":925,"_id":926,"_source":927,"_file":928,"_stem":929,"_extension":930},"/docs/api/cli-reference","api",false,"","CLI Reference","Command reference for the Heaper CLI.",{"type":273,"children":274,"toc":913},"root",[275,283,289,296,474,480,491,506,511,523,532,542,555,560,581,585,594,604,617,622,647,651,660,669,678,688,701,705,753,757,766,775,785,798,802,811,820,830,843,847,855,859,868,877,887,900,904],{"type":276,"tag":277,"props":278,"children":280},"element","h1",{"id":279},"cli-reference",[281],{"type":282,"value":270},"text",{"type":276,"tag":284,"props":285,"children":286},"p",{},[287],{"type":282,"value":288},"The CLI is a wrapper over the local client HTTP API, not the remote server API.",{"type":276,"tag":290,"props":291,"children":293},"h2",{"id":292},"global-options",[294],{"type":282,"value":295},"Global Options",{"type":276,"tag":297,"props":298,"children":299},"table",{},[300,319],{"type":276,"tag":301,"props":302,"children":303},"thead",{},[304],{"type":276,"tag":305,"props":306,"children":307},"tr",{},[308,314],{"type":276,"tag":309,"props":310,"children":311},"th",{},[312],{"type":282,"value":313},"Flag",{"type":276,"tag":309,"props":315,"children":316},{},[317],{"type":282,"value":318},"Description",{"type":276,"tag":320,"props":321,"children":322},"tbody",{},[323,342,367,399,423,440,457],{"type":276,"tag":305,"props":324,"children":325},{},[326,337],{"type":276,"tag":327,"props":328,"children":329},"td",{},[330],{"type":276,"tag":331,"props":332,"children":334},"code",{"className":333},[],[335],{"type":282,"value":336},"--json",{"type":276,"tag":327,"props":338,"children":339},{},[340],{"type":282,"value":341},"Force JSON output instead of table or key/value output.",{"type":276,"tag":305,"props":343,"children":344},{},[345,354],{"type":276,"tag":327,"props":346,"children":347},{},[348],{"type":276,"tag":331,"props":349,"children":351},{"className":350},[],[352],{"type":282,"value":353},"--token \u003Ctoken>",{"type":276,"tag":327,"props":355,"children":356},{},[357,359,365],{"type":282,"value":358},"Local API token. Falls back to ",{"type":276,"tag":331,"props":360,"children":362},{"className":361},[],[363],{"type":282,"value":364},"HEAPER_TOKEN",{"type":282,"value":366},".",{"type":276,"tag":305,"props":368,"children":369},{},[370,379],{"type":276,"tag":327,"props":371,"children":372},{},[373],{"type":276,"tag":331,"props":374,"children":376},{"className":375},[],[377],{"type":282,"value":378},"--port \u003Cport>",{"type":276,"tag":327,"props":380,"children":381},{},[382,384,390,392,398],{"type":282,"value":383},"Local API port. Falls back to ",{"type":276,"tag":331,"props":385,"children":387},{"className":386},[],[388],{"type":282,"value":389},"HEAPER_PORT",{"type":282,"value":391}," or ",{"type":276,"tag":331,"props":393,"children":395},{"className":394},[],[396],{"type":282,"value":397},"~/.heaper/api.json",{"type":282,"value":366},{"type":276,"tag":305,"props":400,"children":401},{},[402,411],{"type":276,"tag":327,"props":403,"children":404},{},[405],{"type":276,"tag":331,"props":406,"children":408},{"className":407},[],[409],{"type":282,"value":410},"--session \u003Cid>",{"type":276,"tag":327,"props":412,"children":413},{},[414,416,422],{"type":282,"value":415},"Resume a saved heap session created by ",{"type":276,"tag":331,"props":417,"children":419},{"className":418},[],[420],{"type":282,"value":421},"heaper use",{"type":282,"value":366},{"type":276,"tag":305,"props":424,"children":425},{},[426,435],{"type":276,"tag":327,"props":427,"children":428},{},[429],{"type":276,"tag":331,"props":430,"children":432},{"className":431},[],[433],{"type":282,"value":434},"--heap \u003Cid>",{"type":276,"tag":327,"props":436,"children":437},{},[438],{"type":282,"value":439},"Override the heap for the current command.",{"type":276,"tag":305,"props":441,"children":442},{},[443,452],{"type":276,"tag":327,"props":444,"children":445},{},[446],{"type":276,"tag":331,"props":447,"children":449},{"className":448},[],[450],{"type":282,"value":451},"--limit \u003Cn>",{"type":276,"tag":327,"props":453,"children":454},{},[455],{"type":282,"value":456},"Pagination limit for commands that support paging.",{"type":276,"tag":305,"props":458,"children":459},{},[460,469],{"type":276,"tag":327,"props":461,"children":462},{},[463],{"type":276,"tag":331,"props":464,"children":466},{"className":465},[],[467],{"type":282,"value":468},"--offset \u003Cn>",{"type":276,"tag":327,"props":470,"children":471},{},[472],{"type":282,"value":473},"Pagination offset for commands that support paging.",{"type":276,"tag":290,"props":475,"children":477},{"id":476},"commands",[478],{"type":282,"value":479},"Commands",{"type":276,"tag":481,"props":482,"children":484},"h3",{"id":483},"heaper-heaps",[485],{"type":276,"tag":331,"props":486,"children":488},{"className":487},[],[489],{"type":282,"value":490},"heaper heaps",{"type":276,"tag":492,"props":493,"children":494},"ul",{},[495,501],{"type":276,"tag":496,"props":497,"children":498},"li",{},[499],{"type":282,"value":500},"Purpose: List all heaps available through the local API.",{"type":276,"tag":496,"props":502,"children":503},{},[504],{"type":282,"value":505},"Local API call: GET /api/heaps",{"type":276,"tag":284,"props":507,"children":508},{},[509],{"type":282,"value":510},"Examples:",{"type":276,"tag":512,"props":513,"children":518},"pre",{"className":514,"code":516,"language":517,"meta":269},[515],"language-bash","heaper heaps\n","bash",[519],{"type":276,"tag":331,"props":520,"children":521},{"__ignoreMap":269},[522],{"type":282,"value":516},{"type":276,"tag":512,"props":524,"children":527},{"className":525,"code":526,"language":517,"meta":269},[515],"HEAPER_TOKEN=\u003Ctoken> heaper heaps --json\n",[528],{"type":276,"tag":331,"props":529,"children":530},{"__ignoreMap":269},[531],{"type":282,"value":526},{"type":276,"tag":481,"props":533,"children":535},{"id":534},"heaper-use-heap-id",[536],{"type":276,"tag":331,"props":537,"children":539},{"className":538},[],[540],{"type":282,"value":541},"heaper use \u003Cheap-id>",{"type":276,"tag":492,"props":543,"children":544},{},[545,550],{"type":276,"tag":496,"props":546,"children":547},{},[548],{"type":282,"value":549},"Purpose: Create a short-lived local session and make that heap the default for later commands.",{"type":276,"tag":496,"props":551,"children":552},{},[553],{"type":282,"value":554},"Local API call: GET /api/heaps/:id",{"type":276,"tag":284,"props":556,"children":557},{},[558],{"type":282,"value":559},"Notes:",{"type":276,"tag":492,"props":561,"children":562},{},[563,568],{"type":276,"tag":496,"props":564,"children":565},{},[566],{"type":282,"value":567},"The command first verifies that the heap exists.",{"type":276,"tag":496,"props":569,"children":570},{},[571,573,579],{"type":282,"value":572},"Sessions are stored in ",{"type":276,"tag":331,"props":574,"children":576},{"className":575},[],[577],{"type":282,"value":578},"~/.heaper/sessions/*.json",{"type":282,"value":580}," and expire after 24 hours.",{"type":276,"tag":284,"props":582,"children":583},{},[584],{"type":282,"value":510},{"type":276,"tag":512,"props":586,"children":589},{"className":587,"code":588,"language":517,"meta":269},[515],"heaper use \u003Cheap-id>\n",[590],{"type":276,"tag":331,"props":591,"children":592},{"__ignoreMap":269},[593],{"type":282,"value":588},{"type":276,"tag":481,"props":595,"children":597},{"id":596},"heaper-blocks",[598],{"type":276,"tag":331,"props":599,"children":601},{"className":600},[],[602],{"type":282,"value":603},"heaper blocks",{"type":276,"tag":492,"props":605,"children":606},{},[607,612],{"type":276,"tag":496,"props":608,"children":609},{},[610],{"type":282,"value":611},"Purpose: List blocks in a heap, optionally filtered or searched.",{"type":276,"tag":496,"props":613,"children":614},{},[615],{"type":282,"value":616},"Local API call: GET /api/heaps/:id/blocks",{"type":276,"tag":284,"props":618,"children":619},{},[620],{"type":282,"value":621},"Options:",{"type":276,"tag":492,"props":623,"children":624},{},[625,636],{"type":276,"tag":496,"props":626,"children":627},{},[628,630],{"type":282,"value":629},"--type ",{"type":276,"tag":631,"props":632,"children":633},"type",{},[634],{"type":282,"value":635},": filter by block type.",{"type":276,"tag":496,"props":637,"children":638},{},[639,641],{"type":282,"value":640},"-q, --query ",{"type":276,"tag":642,"props":643,"children":644},"term",{},[645],{"type":282,"value":646},": full-text search term scoped to the heap.",{"type":276,"tag":284,"props":648,"children":649},{},[650],{"type":282,"value":510},{"type":276,"tag":512,"props":652,"children":655},{"className":653,"code":654,"language":517,"meta":269},[515],"heaper blocks\n",[656],{"type":276,"tag":331,"props":657,"children":658},{"__ignoreMap":269},[659],{"type":282,"value":654},{"type":276,"tag":512,"props":661,"children":664},{"className":662,"code":663,"language":517,"meta":269},[515],"heaper blocks --type document\n",[665],{"type":276,"tag":331,"props":666,"children":667},{"__ignoreMap":269},[668],{"type":282,"value":663},{"type":276,"tag":512,"props":670,"children":673},{"className":671,"code":672,"language":517,"meta":269},[515],"heaper blocks --query project --limit 20\n",[674],{"type":276,"tag":331,"props":675,"children":676},{"__ignoreMap":269},[677],{"type":282,"value":672},{"type":276,"tag":481,"props":679,"children":681},{"id":680},"heaper-block-block-id",[682],{"type":276,"tag":331,"props":683,"children":685},{"className":684},[],[686],{"type":282,"value":687},"heaper block \u003Cblock-id>",{"type":276,"tag":492,"props":689,"children":690},{},[691,696],{"type":276,"tag":496,"props":692,"children":693},{},[694],{"type":282,"value":695},"Purpose: Fetch a single block with relations, files, and related local data.",{"type":276,"tag":496,"props":697,"children":698},{},[699],{"type":282,"value":700},"Local API call: GET /api/blocks/:id",{"type":276,"tag":284,"props":702,"children":703},{},[704],{"type":282,"value":621},{"type":276,"tag":492,"props":706,"children":707},{},[708,719,737],{"type":276,"tag":496,"props":709,"children":710},{},[711,717],{"type":276,"tag":331,"props":712,"children":714},{"className":713},[],[715],{"type":282,"value":716},"--view \u003Cview-id-or-name>",{"type":282,"value":718},": resolve one saved app view on the block and return a paginated result set for that filtered view.",{"type":276,"tag":496,"props":720,"children":721},{},[722,727,729,735],{"type":276,"tag":331,"props":723,"children":725},{"className":724},[],[726],{"type":282,"value":451},{"type":282,"value":728},": page size for relations, backlinks, and ",{"type":276,"tag":331,"props":730,"children":732},{"className":731},[],[733],{"type":282,"value":734},"--view",{"type":282,"value":736}," results.",{"type":276,"tag":496,"props":738,"children":739},{},[740,745,747,752],{"type":276,"tag":331,"props":741,"children":743},{"className":742},[],[744],{"type":282,"value":468},{"type":282,"value":746},": page offset for relations, backlinks, and ",{"type":276,"tag":331,"props":748,"children":750},{"className":749},[],[751],{"type":282,"value":734},{"type":282,"value":736},{"type":276,"tag":284,"props":754,"children":755},{},[756],{"type":282,"value":510},{"type":276,"tag":512,"props":758,"children":761},{"className":759,"code":760,"language":517,"meta":269},[515],"heaper block \u003Cblock-id>\n",[762],{"type":276,"tag":331,"props":763,"children":764},{"__ignoreMap":269},[765],{"type":282,"value":760},{"type":276,"tag":512,"props":767,"children":770},{"className":768,"code":769,"language":517,"meta":269},[515],"heaper block \u003Cblock-id> --view \"\u003Cview-id-or-name>\" --limit 25 --offset 0\n",[771],{"type":276,"tag":331,"props":772,"children":773},{"__ignoreMap":269},[774],{"type":282,"value":769},{"type":276,"tag":481,"props":776,"children":778},{"id":777},"heaper-search-query",[779],{"type":276,"tag":331,"props":780,"children":782},{"className":781},[],[783],{"type":282,"value":784},"heaper search \u003Cquery>",{"type":276,"tag":492,"props":786,"children":787},{},[788,793],{"type":276,"tag":496,"props":789,"children":790},{},[791],{"type":282,"value":792},"Purpose: Run full-text search across local blocks, optionally within the current heap session.",{"type":276,"tag":496,"props":794,"children":795},{},[796],{"type":282,"value":797},"Local API call: GET /api/search",{"type":276,"tag":284,"props":799,"children":800},{},[801],{"type":282,"value":510},{"type":276,"tag":512,"props":803,"children":806},{"className":804,"code":805,"language":517,"meta":269},[515],"heaper search \"meeting notes\"\n",[807],{"type":276,"tag":331,"props":808,"children":809},{"__ignoreMap":269},[810],{"type":282,"value":805},{"type":276,"tag":512,"props":812,"children":815},{"className":813,"code":814,"language":517,"meta":269},[515],"heaper search roadmap --limit 10\n",[816],{"type":276,"tag":331,"props":817,"children":818},{"__ignoreMap":269},[819],{"type":282,"value":814},{"type":276,"tag":481,"props":821,"children":823},{"id":822},"heaper-query-sql-params",[824],{"type":276,"tag":331,"props":825,"children":827},{"className":826},[],[828],{"type":282,"value":829},"heaper query \u003Csql> [params...]",{"type":276,"tag":492,"props":831,"children":832},{},[833,838],{"type":276,"tag":496,"props":834,"children":835},{},[836],{"type":282,"value":837},"Purpose: Execute a read-only SQL query against the local data store.",{"type":276,"tag":496,"props":839,"children":840},{},[841],{"type":282,"value":842},"Local API call: POST /api/query",{"type":276,"tag":284,"props":844,"children":845},{},[846],{"type":282,"value":559},{"type":276,"tag":492,"props":848,"children":849},{},[850],{"type":276,"tag":496,"props":851,"children":852},{},[853],{"type":282,"value":854},"CLI parameters after the SQL string are parsed as JSON when possible before they are sent as SQL params.",{"type":276,"tag":284,"props":856,"children":857},{},[858],{"type":282,"value":510},{"type":276,"tag":512,"props":860,"children":863},{"className":861,"code":862,"language":517,"meta":269},[515],"heaper query \"SELECT id, title FROM blocks LIMIT 5\"\n",[864],{"type":276,"tag":331,"props":865,"children":866},{"__ignoreMap":269},[867],{"type":282,"value":862},{"type":276,"tag":512,"props":869,"children":872},{"className":870,"code":871,"language":517,"meta":269},[515],"heaper query \"SELECT id, title FROM blocks WHERE workspace_id = ?\" '\"\u003Cheap-id>\"'\n",[873],{"type":276,"tag":331,"props":874,"children":875},{"__ignoreMap":269},[876],{"type":282,"value":871},{"type":276,"tag":481,"props":878,"children":880},{"id":879},"heaper-info",[881],{"type":276,"tag":331,"props":882,"children":884},{"className":883},[],[885],{"type":282,"value":886},"heaper info",{"type":276,"tag":492,"props":888,"children":889},{},[890,895],{"type":276,"tag":496,"props":891,"children":892},{},[893],{"type":282,"value":894},"Purpose: Show local API status plus the latest active heap session.",{"type":276,"tag":496,"props":896,"children":897},{},[898],{"type":282,"value":899},"Local API call: GET /api/info",{"type":276,"tag":284,"props":901,"children":902},{},[903],{"type":282,"value":510},{"type":276,"tag":512,"props":905,"children":908},{"className":906,"code":907,"language":517,"meta":269},[515],"heaper info\n",[909],{"type":276,"tag":331,"props":910,"children":911},{"__ignoreMap":269},[912],{"type":282,"value":907},{"title":269,"searchDepth":28,"depth":28,"links":914},[915,916],{"id":292,"depth":28,"text":295},{"id":476,"depth":28,"text":479,"children":917},[918,919,920,921,922,923,924],{"id":483,"depth":59,"text":490},{"id":534,"depth":59,"text":541},{"id":596,"depth":59,"text":603},{"id":680,"depth":59,"text":687},{"id":777,"depth":59,"text":784},{"id":822,"depth":59,"text":829},{"id":879,"depth":59,"text":886},"markdown","content:docs:api:cli-reference.md","content","docs/api/cli-reference.md","docs/api/cli-reference","md",1777640558103]