========================
CODE SNIPPETS
========================
TITLE: Inno Setup Script for VisiData Installer (Windows)
DESCRIPTION: This refers to the `vd.iss` script, which is an Inno Setup configuration file used to define the parameters for building the VisiData Windows installer. It specifies installation paths, files to include, and other installer properties.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_8

LANGUAGE: Inno Setup Script
CODE:
```
vd.iss
```

----------------------------------------

TITLE: Example VisiData Guide Content for Macros
DESCRIPTION: This snippet provides a complete example of the content for a VisiData guide, including the YAML front matter and the main body. It illustrates how to describe a feature (Macros), outline basic usage steps, and reference VisiData commands using the '{help.commands.command-name}' syntax for auto-completion and linking within the application.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/guides.rst#_snippet_1

LANGUAGE: Markdown
CODE:
```
---
sheettype: Sheet
---
# Macros
Macros allow you to bind a command sequence to a keystroke or longname, to replay when that
keystroke is pressed or the command is executed by longname.

The basic usage is:
    1. {help.commands.macro-record}
    2. Execute a series of commands.
    3. `m` again to complete the recording, and prompt for the keystroke or longname to bind it to.

# The Macros Sheet

- {help.commands.macro-sheet}

- `d` (`delete-row`) to mark macros for deletion.
- {help.commands.commit_sheet}
- `Enter` (`open-row`) to open the macro in the current row, and view the series of commands composing it.
'''
```

----------------------------------------

TITLE: Installing VisiData with Test Dependencies (Shell)
DESCRIPTION: This command sequence clones the VisiData repository from GitHub, navigates into the directory, and then installs VisiData along with its specific test dependencies using pip3. This setup is essential before running any tests.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/test.md#_snippet_0

LANGUAGE: Shell
CODE:
```
git clone https://github.com/saulpw/visidata.git
cd visidata
pip3 install ".[test]"
```

----------------------------------------

TITLE: Installing VisiData Develop Branch via pip (Windows)
DESCRIPTION: This command installs the development version of VisiData directly from its Git repository's `develop` branch. It requires Git to be installed and is used for testing the latest features or contributing to the project.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_2

LANGUAGE: Shell
CODE:
```
pip3 install git+https://github.com/saulpw/visidata.git@develop
```

----------------------------------------

TITLE: Installing PyInstaller via pip (Windows)
DESCRIPTION: This command installs PyInstaller, a tool used to bundle Python applications into standalone executables. It is a prerequisite for compiling VisiData into a single executable file for distribution.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_4

LANGUAGE: Shell
CODE:
```
./Scripts/pip3.exe install pyinstaller
```

----------------------------------------

TITLE: Installing VisiData via pip (Windows)
DESCRIPTION: This command uses the `pip3` package installer from the WinPY environment to install the stable version of VisiData. It ensures that VisiData and its core dependencies are available for use.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_1

LANGUAGE: Shell
CODE:
```
./Scripts/pip3.exe install visidata
```

----------------------------------------

TITLE: Installing VisiData Latest Release (Python)
DESCRIPTION: This command installs the latest stable release of VisiData from PyPi using pip3. It is the recommended way to get VisiData for general use and ensures you have the most recent stable features and bug fixes.

SOURCE: https://github.com/saulpw/visidata/blob/develop/README.md#_snippet_0

LANGUAGE: Shell
CODE:
```
pip3 install visidata
```

----------------------------------------

TITLE: Initial Pivot Table Example in VisiData
DESCRIPTION: This snippet shows an example of a pivot table in VisiData, created by pivoting columns `R`, `B` with `date` as the key, and using `sum` and `mean` aggregators. It serves as the starting point for melt operations.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/guides/MeltGuide.md#_snippet_0

LANGUAGE: VisiData Table
CODE:
```
   date        sum_R  mean_R  sum_B  mean_B
   ----------  -----  ------  -----  ------
   2024-09-01  30     30      0
   2024-09-02  0              28     28
   2024-09-03  100    100     132    66
```

----------------------------------------

TITLE: Starting VisiData at Specific Sheet, Row, Column
DESCRIPTION: This command loads an XLSX file (`sample-sales-reps.xlsx`) and uses the `+:` syntax to specify an initial sheet (`sample-salesv4`), row (`2`), and column (`3`) to start at. This tests VisiData's ability to open a file at a precise location.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/checklists/manual-tests.md#_snippet_8

LANGUAGE: Shell
CODE:
```
bin/vd +:sample-salesv4:2:3 sample_data/sample-sales-reps.xlsx
```

----------------------------------------

TITLE: Installing VisiData Develop Branch (Python)
DESCRIPTION: This command installs the cutting-edge `develop` branch of VisiData directly from its GitHub repository. This version may contain the latest features and experimental changes but comes with no warranty and might be less stable.

SOURCE: https://github.com/saulpw/visidata/blob/develop/README.md#_snippet_1

LANGUAGE: Shell
CODE:
```
pip3 install git+https://github.com/saulpw/visidata.git@develop
```

----------------------------------------

TITLE: Cloning VisiData Windows Installer Repository (Windows)
DESCRIPTION: This command clones the `vdwin` repository, which contains scripts and resources specific to packaging VisiData for Windows, into the `WinPy/vdwin` directory. This repository is essential for the PyInstaller build process.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_5

LANGUAGE: Shell
CODE:
```
git clone https://github.com/saulpw/vdwin.git WinPy/vdwin
```

----------------------------------------

TITLE: Compiling VisiData Executable with PyInstaller (Windows)
DESCRIPTION: This command uses PyInstaller to compile the VisiData application into a single executable file. It specifies the output name, an icon, and the main VisiData Python script, creating a standalone `visidata.exe`.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_6

LANGUAGE: Shell
CODE:
```
./Scripts/pyinstaller.exe --onefile/-F --icon/-i ..\vdwin\vdicon.ico --name/-n VisiData ..\vdwin\visidata.py
```

----------------------------------------

TITLE: Installing Ibis PostgreSQL Backend
DESCRIPTION: This command installs the PostgreSQL backend for Ibis, which is required for `vdsql` to connect to PostgreSQL databases. By default, only the SQLite backend is included, and other backends must be installed separately to enable their support.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/vdsql/README.md#_snippet_2

LANGUAGE: Shell
CODE:
```
pip install 'ibis-framework[postgres]'
```

----------------------------------------

TITLE: Installing vdsql Manually (Development Version)
DESCRIPTION: These commands allow for a manual installation of the cutting-edge development version of `vdsql` directly from the VisiData Git repository. This method is suitable for developers or users who need the very latest features and are comfortable with a potentially less stable build.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/vdsql/README.md#_snippet_1

LANGUAGE: Shell
CODE:
```
git clone git@github.com:saulpw/visidata.git
cd visidata/visidata/apps/vdsql
pip3 install .
```

----------------------------------------

TITLE: Starting Galactic Conquest Server (Shell)
DESCRIPTION: This command starts the Galactic Conquest game server. The optional `-p` flag allows specifying a custom port; otherwise, it defaults to 8080. The server will output a URL for clients to connect.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/galcon/README.md#_snippet_0

LANGUAGE: Shell
CODE:
```
./galcon-server.py [-p <port>]
```

----------------------------------------

TITLE: Installing Windows Curses for VisiData (Windows)
DESCRIPTION: This command installs the `windows-curses` library, which provides `curses` compatibility on Windows. This dependency is crucial for VisiData's terminal-based user interface to function correctly.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_3

LANGUAGE: Shell
CODE:
```
./Scripts/pip3.exe install windows-curses
```

----------------------------------------

TITLE: Example Nested Data for VisiData Column Expansion
DESCRIPTION: This JSON array provides an example of nested data structures, including arrays and objects, that VisiData's `(` family of commands can expand into top-level columns. It demonstrates various levels of nesting for testing expansion capabilities.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_23

LANGUAGE: JSON
CODE:
```
[
    [ "short", "array" ],
    [ "slightly", "longer", "array" ],
    { "nested": "data" },
    { "more": { "deeply": { "nested": "data" } } }
]
```

----------------------------------------

TITLE: Programmatically Setting Options in VisiData
DESCRIPTION: Provides examples of programmatically setting options in VisiData, demonstrating how to set sheet-specific, global, or type-specific options.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/design/169-settings.md#_snippet_10

LANGUAGE: Python
CODE:
```
<Sheet>.options.my_option = "value"
options.my_option = "global default"
Canvas.options.my_option = 42
```

----------------------------------------

TITLE: Navigating to WinPY Python Directory (Windows)
DESCRIPTION: This command changes the current directory to the WinPY Python installation path, which is a prerequisite for running Python scripts and commands within the WinPython environment.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_0

LANGUAGE: Shell
CODE:
```
cd WinPY\python-3.9.4.amd64
```

----------------------------------------

TITLE: Installing vdsql Latest Release
DESCRIPTION: This command installs the latest stable release of `vdsql`, which includes the `vd` command with the `vdsql` plugin enabled and a dedicated `vdsql` script. It allows VisiData to use Ibis for database loading instead of its built-in loaders.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/vdsql/README.md#_snippet_0

LANGUAGE: Shell
CODE:
```
pip install vdsql
```

----------------------------------------

TITLE: Installing vgit via pip
DESCRIPTION: This command installs the vgit package directly from its GitHub repository using pip. It specifies the branch and subdirectory to ensure the correct module is installed, along with its VisiData dependency.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/vgit/README.md#_snippet_0

LANGUAGE: Shell
CODE:
```
pip install git+https://github.com/saulpw/visidata.git@branch#subdirectory=visidata/apps/vgit
```

----------------------------------------

TITLE: Installing the rvisidata R Package (R)
DESCRIPTION: This R command installs the 'rvisidata' package directly from GitHub using 'devtools::install_github()'. This package provides the bridge for opening R data frames within VisiData.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/loading.md#_snippet_5

LANGUAGE: R
CODE:
```
devtools::install_github('paulklemm/rvisidata')
```

----------------------------------------

TITLE: Accessing Command and Binding Dictionaries
DESCRIPTION: Provides examples of how to access dictionaries containing all available commands and keybindings, either globally or specific to a SheetType or the VisiData (vs) object.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/design/169-settings.md#_snippet_6

LANGUAGE: Python
CODE:
```
commands
SheetType.commands
vs.commands
bindings
SheetType.bindings
```

----------------------------------------

TITLE: Starting New Branch (vgit)
DESCRIPTION: Creates a new Git branch. This action is equivalent to `git branch <branch_name>`.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/vgit/vgit-guide.md#_snippet_3

LANGUAGE: Git
CODE:
```
git branch <branch_name>
```

----------------------------------------

TITLE: Example: Filtering Rows by Item and Units in VisiData
DESCRIPTION: Demonstrates a specific workflow to filter rows based on multiple conditions (Item and Units) using VisiData's `z|` command and then open a new sheet with the filtered results. Requires setting column type.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_2

LANGUAGE: VisiData
CODE:
```
#
z| Item == 'Binder' and Units < 10
"
```

----------------------------------------

TITLE: Defining and Binding a Custom VisiData Command (Python)
DESCRIPTION: This example illustrates how to create a custom API method (`show_hello`) for VisiData sheets, register it as a command (`show-hello`), and then bind multiple keyboard shortcuts (Shift+H, Ctrl+H, Alt+H) to execute this command. It shows the full lifecycle from function definition to user interaction via keybindings.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/commands.rst#_snippet_1

LANGUAGE: Python
CODE:
```
@Sheet.api
def show_hello(sheet):
    vd.status(sheet.options.disp_hello)

# `sheet` members and `vd` members are available in the execstr scope
BaseSheet.addCommand(None, 'show-hello', 'show_hello()', 'show a warm greeting')

# bind Shift+H, Ctrl+H, and Alt+H to this command
BaseSheet.bindkey('H', 'show-hello')
BaseSheet.bindkey('^H', 'show-hello')
BaseSheet.bindkey(ALT+'h', 'show-hello')
```

----------------------------------------

TITLE: Documenting VisiData Options
DESCRIPTION: This pattern outlines the standard format for documenting VisiData options. It includes a clickable link to the options sheet, the option's name formatted as code, its help string, and its default value. This structure ensures comprehensive and interactive documentation for VisiData configuration options.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_6

LANGUAGE: VisiData Documentation Pattern
CODE:
```
[:onclick options-sheet <option name>][:code]option name>[/] to <option helpstring> (default: <option default value>)
```

----------------------------------------

TITLE: Locating Compiled VisiData Executable (Windows)
DESCRIPTION: This path indicates the location of the compiled VisiData executable after PyInstaller has successfully run. Users can navigate to this directory and run `visidata.exe` directly.

SOURCE: https://github.com/saulpw/visidata/blob/develop/platform/windows/vdwin-installer.md#_snippet_7

LANGUAGE: Shell
CODE:
```
dist\visidata\visidata.exe
```

----------------------------------------

TITLE: Using Predefined Color Options in VisiData
DESCRIPTION: These snippets show examples of using predefined color option names within VisiData's display attribute syntax. These options, such as [:warning], [:error], and [:menu], allow for consistent application of themed colors across the interface, preferring them over hard-coded color values.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_2

LANGUAGE: VisiData Attribute Syntax
CODE:
```
[:warning]
```

LANGUAGE: VisiData Attribute Syntax
CODE:
```
[:error]
```

LANGUAGE: VisiData Attribute Syntax
CODE:
```
[:menu]
```

----------------------------------------

TITLE: Adding YAML Front Matter to VisiData Guide
DESCRIPTION: This snippet demonstrates the optional YAML front matter used at the beginning of a VisiData guide markdown file. It allows overriding default configurations, such as specifying the 'sheettype' which aids VisiData in auto-completing command and option patterns. The default 'sheettype' is 'Sheet'.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/guides.rst#_snippet_0

LANGUAGE: YAML
CODE:
```
---
sheettype: Sheet
---
```

----------------------------------------

TITLE: Setting VisiData Theme via CLI (Shell)
DESCRIPTION: This command-line snippet demonstrates how to start VisiData with a specific theme, `asciimono`, using the `--theme` option. This is useful for environments like classic VT102 terminals.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/colors.md#_snippet_8

LANGUAGE: Shell
CODE:
```
vd --theme=asciimono
```

----------------------------------------

TITLE: Applying Custom Colors in VisiData
DESCRIPTION: This example illustrates how to apply specific foreground and background colors to text using VisiData's internal display attributes. It changes the <sentence> to red text on a black background. VisiData also supports using predefined color option names like [:warning] or [:error] for consistent theming.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_1

LANGUAGE: VisiData Attribute Syntax
CODE:
```
[:red on black]<sentence>[/]
```

----------------------------------------

TITLE: Uploading Debian Package to Mentors
DESCRIPTION: This command uploads the generated Debian package changes file to the Debian Mentors platform, which is used for new or unmaintained packages to get reviewed and sponsored into the official Debian archives.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/checklists/release.md#_snippet_5

LANGUAGE: Shell
CODE:
```
dput mentors visidata_ver.changes
```

----------------------------------------

TITLE: Documenting VisiData Commands
DESCRIPTION: This pattern defines the standard format for listing VisiData commands in documentation. It specifies how to display the keystroke ([:keys]), the command's longname ([:code]), and its associated help string. The {help.commands.<longname>} placeholder is preferred for automatic expansion by the GuideSheet, ensuring consistent formatting.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_4

LANGUAGE: VisiData Documentation Pattern
CODE:
```
- [:keys]<keystroke>[/] ([:code]<longname>[/]) to <command helpstring>
```

----------------------------------------

TITLE: Auto-Generating Option Documentation in VisiData
DESCRIPTION: This placeholder is used in VisiData documentation to automatically generate the formatted string for an option. When processed, {help.options.<option-name>} expands into the standard option listing, including its clickable link, name, help string, and default value, ensuring consistent and dynamic documentation.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_7

LANGUAGE: VisiData Documentation Placeholder
CODE:
```
{help.options.<option-name>}
```

----------------------------------------

TITLE: Importing Manually Installed VisiData Plugin (Python)
DESCRIPTION: This Python import statement, added to the `.visidatarc` file, loads a plugin that has been manually copied into the `~/.visidata/plugins/` directory. It makes the functionality provided by `myplugin.py` available within VisiData upon startup.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/plugins.md#_snippet_3

LANGUAGE: Python
CODE:
```
import plugins.myplugin
```

----------------------------------------

TITLE: Formatting Option Helpstrings in VisiData
DESCRIPTION: This pattern specifies how relevant options should be listed in VisiData documentation. It creates a clickable link to the options sheet for `<option name>`, displays the option name, its helpstring, and its default value. Using `{help.options.option-name}` is preferred for automatic expansion.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/docs-style.md#_snippet_3

LANGUAGE: VisiData Documentation Pattern
CODE:
```
- [:onclick options-sheet <option name>]`<option name>`[/] to <option helpstring> (default: <option default value>).
```

----------------------------------------

TITLE: Creating Custom Toolbar with OnClick Commands (VisiData CLI)
DESCRIPTION: This command-line example creates a custom VisiData toolbar (`disp_menu_fmt`) with two clickable actions. "freq out" executes the `freq-col` command, and "back" executes the `quit-sheet` command.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/colors.md#_snippet_7

LANGUAGE: Shell
CODE:
```
vd --disp_menu_fmt="[:onclick freq-col] freq out [/] | [:onclick quit-sheet] back [/]"
```

----------------------------------------

TITLE: Selecting a Random Subset of Rows in VisiData
DESCRIPTION: Explains how to select a random number of rows from the current sheet using the `random-rows` command in VisiData.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_3

LANGUAGE: VisiData
CODE:
```
Space random-rows *number*
```

----------------------------------------

TITLE: Loading Pandas-Supported File Formats with VisiData (Shell)
DESCRIPTION: This example demonstrates how to leverage VisiData's pandas adapter to load file formats that pandas supports, such as Parquet. The '-f pandas' flag is used, and the correct file extension is mandatory for this method.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/loading.md#_snippet_4

LANGUAGE: Shell
CODE:
```
vd -f pandas data.parquet
```

----------------------------------------

TITLE: Adding 'Hello World' Command to BaseSheet (Python)
DESCRIPTION: This snippet demonstrates how to add a custom command to all VisiData sheets. When the '1' key is pressed, it executes the 'hello-world' command, displaying 'Hello world!' on the status bar. It extends the `BaseSheet` class, making the command available globally.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/index.rst#_snippet_0

LANGUAGE: Python
CODE:
```
BaseSheet.addCommand('1', 'hello-world', 'status("Hello world!")')
```

----------------------------------------

TITLE: Custom Cell Colorizer for Specific Columns and Rows in VisiData (Python)
DESCRIPTION: This Python example demonstrates a `CellColorizer` within an `OptionsSheet` to apply dynamic colors to individual cells. The color is determined by the cell's typed value, but only if the cell is in columns 1 or 2 and its row name starts with 'color_'. This allows for conditional cell-level styling.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/interface.rst#_snippet_3

LANGUAGE: Python
CODE:
```
class OptionsSheet(TableSheet):
    colorizers = [
        # colors cells
        CellColorizer(3, None, lambda s,c,r,v: v.value if r and c in s.columns[1:3] and r.name.startswith('color_') else None)
    ]
```

----------------------------------------

TITLE: Formatting Clickable URLs in VisiData
DESCRIPTION: This VisiData display attribute syntax formats text into a clickable URL. When clicked, the URL specified by `<url>` will open in the user's default browser (`$BROWSER`). The `<text>` part is what is displayed to the user.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/docs-style.md#_snippet_0

LANGUAGE: VisiData Syntax
CODE:
```
[:onclick <url>]<text>[/] formats <text> into a clickable url that will open in $BROWSER.
```

----------------------------------------

TITLE: Formatting Command Helpstrings in VisiData
DESCRIPTION: This pattern defines how command helpstrings should be formatted in VisiData's GuideSheet. It displays the `<keystroke>` for a command, followed by its `<longname>` in parentheses, and then the `<command helpstring>`. It's preferred to use `{help.commands.longname}` for automatic formatting.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/docs-style.md#_snippet_2

LANGUAGE: VisiData Documentation Pattern
CODE:
```
- `<keystroke>` (`<longname>`) to <command helpstring>.
```

----------------------------------------

TITLE: Building and Uploading VisiData to PyPI
DESCRIPTION: These shell commands prepare the distribution archives (`sdist` and `bdist_wheel`) for VisiData, set appropriate permissions on the `dist/` directory, list the generated files, and then upload them to PyPI using `twine`.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/checklists/release.md#_snippet_1

LANGUAGE: Shell
CODE:
```
rm -rf dist/
python3 setup.py sdist bdist_wheel
chmod -R a+rX dist
ls dist/
twine upload dist/*
```

----------------------------------------

TITLE: Example: Adding NumPy's IRR Aggregator in VisiData (Python)
DESCRIPTION: This example demonstrates how to integrate an external library function, specifically NumPy's internal rate of return (`np.irr`), as a custom aggregator in VisiData. It shows the necessary import statement and the `vd.aggregator` call to register 'irr' with a float type.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/customize.md#_snippet_4

LANGUAGE: Python
CODE:
```
import numpy as np
vd.aggregator('irr', np.irr, type=float)
```

----------------------------------------

TITLE: Copying and Pasting Single Rows in VisiData
DESCRIPTION: Explains the process of copying a single row to the clipboard and then pasting it at a desired location within the VisiData sheet.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_7

LANGUAGE: VisiData
CODE:
```
y
(move cursor to desired location)
p / Shift+P
```

----------------------------------------

TITLE: Enabling Text Wrapping (Command Line) - VisiData CLI
DESCRIPTION: This snippet provides the command-line option to enable text wrapping for all TextSheets within a VisiData session. This is useful for quickly applying the setting without interacting with the GUI.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_16

LANGUAGE: VisiData CLI
CODE:
```
--wrap
```

----------------------------------------

TITLE: Launching VisiData with Input File (Shell)
DESCRIPTION: This command launches VisiData and loads the specified input file for immediate exploration. Replace `<input>` with the actual path to your data file, such as a CSV, TSV, or SQLite database.

SOURCE: https://github.com/saulpw/visidata/blob/develop/README.md#_snippet_2

LANGUAGE: Shell
CODE:
```
vd <input>
```

----------------------------------------

TITLE: Connecting to Hotmail IMAP Server with VisiData
DESCRIPTION: This specific example demonstrates connecting VisiData to a Hotmail (Outlook) IMAP server. It includes the email address, password, and the IMAP server address with port 993, enabling VisiData to access emails from the specified account.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/formats.md#_snippet_6

LANGUAGE: Shell
CODE:
```
vd "imap://someone@hotmail.com:pass123@imap-mail.outlook.com:993"
```

----------------------------------------

TITLE: Selecting Non-Null or Non-Empty Rows in VisiData
DESCRIPTION: Describes how to select rows where the current column's cells are neither null (`None`) nor empty (`''`) using a specific VisiData command.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_4

LANGUAGE: VisiData
CODE:
```
| .
```

----------------------------------------

TITLE: Setting Options via cmdlog Command
DESCRIPTION: Illustrates the parameters used with the 'cmdlog' command to programmatically set an option, mimicking user input in the options sheet.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/design/169-settings.md#_snippet_9

LANGUAGE: VisiData Command
CODE:
```
command=option, input='value', row='my_option'
```

----------------------------------------

TITLE: Enabling Text Wrapping (Configuration File) - VisiData Configuration
DESCRIPTION: This snippet shows the configuration setting to persistently enable text wrapping for all TextSheets across every VisiData session. This setting is placed in the user's ~/.visidatarc file.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_17

LANGUAGE: VisiData Configuration
CODE:
```
options.wrap = True
```

----------------------------------------

TITLE: Declaring and Accessing VisiData Options (Python)
DESCRIPTION: This snippet provides a comprehensive example of declaring a VisiData option and then demonstrating both global and sheet-specific access. It shows how to define `disp_hello` with a default, then globally override it, and finally how to retrieve its value within the context of a specific sheet using `sheet.options.disp_hello` for display.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/options.rst#_snippet_4

LANGUAGE: Python
CODE:
```
vd.option('disp_hello', 'Hello world!', 'string to display for hello-world')

# option without regard to a current sheet (global override only)
vd.options.disp_hello = 'こんにちは世界'

# show the option value given the context of a specific sheet
vd.status(sheet.options.disp_hello)
```

----------------------------------------

TITLE: Auto-Generating Command Documentation in VisiData
DESCRIPTION: This placeholder is used within VisiData documentation to automatically generate the formatted string for a command. When processed by the GuideSheet, {help.commands.<longname>} expands into the standard command listing, promoting consistency and reducing manual formatting effort. It requires the corresponding docstring to be correctly defined.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_5

LANGUAGE: VisiData Documentation Placeholder
CODE:
```
{help.commands.<longname>}
```

----------------------------------------

TITLE: Moving Cursor Rows in VisiData
DESCRIPTION: Details VisiData commands for navigating the cursor row within a sheet, including moving it incrementally or to the sheet's extremities.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_6

LANGUAGE: VisiData
CODE:
```
J K
```

LANGUAGE: VisiData
CODE:
```
gJ gK
```

----------------------------------------

TITLE: Unhiding All Columns with `gv` in VisiData
DESCRIPTION: This command quickly unhides all columns on the current VisiData sheet, restoring their visibility with a single key combination.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_3

LANGUAGE: VisiData Commands
CODE:
```
`gv` to unhide all columns on current sheet.
```

----------------------------------------

TITLE: Running VisiData Application with TsvSheet - Python
DESCRIPTION: This is the top-level entry point for the VisiData application. It constructs `TsvSheet` instances for each filename provided as a command-line argument (excluding the script's own name). These sheet instances are then passed to the `run()` function, which initializes and starts the VisiData interactive interface.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/viewtsv.md#_snippet_11

LANGUAGE: Python
CODE:
```
run(*(TsvSheet(fn, source=fn) for fn in sys.argv[1:]))
```

----------------------------------------

TITLE: Analyzing VisiData Profile Data with pyprof2calltree and kcachegrind (Shell)
DESCRIPTION: These shell commands convert and visualize VisiData profiling data. The `pyprof2calltree` tool transforms a `.pyprof` file into a `kcachegrind` compatible format, which is then opened by `kcachegrind` for graphical analysis of call graphs and performance hotspots. This requires `pyprof2calltree` and `kcachegrind` to be installed.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/perf-analysis.md#_snippet_1

LANGUAGE: Shell
CODE:
```
pyprof2calltree -i foo.pyprof -o foo.kcachegrind
kcachegrind foo.kcachegrind
```

----------------------------------------

TITLE: Splitting Columns by Regex Pattern in VisiData
DESCRIPTION: The `:` command in VisiData creates new columns by splitting the current column's content based on a provided regex pattern. It uses `options.default_sample_size` (default: 100) rows around the cursor to determine the number of new columns.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_13

LANGUAGE: VisiData
CODE:
```
:
```

----------------------------------------

TITLE: Applying Semantic Formatting in VisiData
DESCRIPTION: These attributes are used for semantic formatting within VisiData documentation. [:keys] is designated for formatting keystrokes and longnames, while [:code] is used for displaying actual programming code, such as Python snippets, ensuring visual distinction and clarity.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_3

LANGUAGE: VisiData Attribute Syntax
CODE:
```
[:keys]
```

LANGUAGE: VisiData Attribute Syntax
CODE:
```
[:code]
```

----------------------------------------

TITLE: Moving Columns in VisiData
DESCRIPTION: This section details commands for repositioning columns within a VisiData sheet. Commands allow for single-position shifts or moving a column to the extreme left/right of its section.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_0

LANGUAGE: VisiData Commands
CODE:
```
`!`             pins the current column on the left as a key column
 `H`  `L`       slides the current column **one position** to the left/right
`gH` `gL`       slides the current column **all the way** to the left/right of its section
```

----------------------------------------

TITLE: Profiling VisiData Startup Time with cProfile (Shell)
DESCRIPTION: This shell command initiates VisiData with Python's `cProfile` module to measure startup performance. It outputs the profiling data to `startup-vd.pyprof` and suppresses the initial welcome screen (`-N`). This helps identify functions contributing most to the application's launch time.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/perf-analysis.md#_snippet_0

LANGUAGE: Shell
CODE:
```
time python -m cProfile -o startup-vd.pyprof bin/vd -N
```

----------------------------------------

TITLE: Filtering Selected Rows in VisiData
DESCRIPTION: This section explains how to filter rows in VisiData by first selecting them, then performing actions like deleting, opening a duplicate sheet with references, or opening a copy of selected rows.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_1

LANGUAGE: VisiData
CODE:
```
s or t
gd
```

LANGUAGE: VisiData
CODE:
```
s or t
"
```

LANGUAGE: VisiData
CODE:
```
s or t
g"
```

LANGUAGE: VisiData
CODE:
```
s or t
z"
```

LANGUAGE: VisiData
CODE:
```
s or t
gz"
```

----------------------------------------

TITLE: Selecting Null or Empty Rows in VisiData
DESCRIPTION: Provides various methods to select rows containing null (`None`) or empty (`''`) cells in a specified column, distinguishing between typed and display values, and using Python expressions.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_5

LANGUAGE: VisiData
CODE:
```
z, (on None cell)
```

LANGUAGE: VisiData
CODE:
```
, (on empty or None cell)
```

LANGUAGE: VisiData
CODE:
```
z. (on empty cell)
```

LANGUAGE: VisiData
CODE:
```
Shift+I
(navigate to nulls column and source column row)
zs
```

LANGUAGE: VisiData/Python
CODE:
```
z| not ColumnName
```

LANGUAGE: VisiData/Python
CODE:
```
z| ColumnName.val is None
```

----------------------------------------

TITLE: Loading DirSheet with Sample Data (CLI)
DESCRIPTION: Loads a DirSheet in VisiData, displaying files and folders from the 'sample_data/' directory. This command is executed from the command line.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/guides/DirSheet.md#_snippet_0

LANGUAGE: Shell
CODE:
```
vd sample_data/
```

----------------------------------------

TITLE: Sorting Rows Overview - VisiData Keybindings
DESCRIPTION: This table summarizes the primary VisiData keybindings used for sorting rows. It distinguishes between sorting by the current column versus all key columns, and whether to replace or add to existing sort criteria.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_9

LANGUAGE: VisiData Keybindings
CODE:
```
[
]
```

LANGUAGE: VisiData Keybindings
CODE:
```
g[
g]
```

LANGUAGE: VisiData Keybindings
CODE:
```
z[
z]
```

LANGUAGE: VisiData Keybindings
CODE:
```
gz[
gz]
```

----------------------------------------

TITLE: Selecting and Unselecting Rows by Criteria in VisiData
DESCRIPTION: This section details VisiData commands used to select or unselect rows based on cursor position, sheet-wide selection, or pattern matching using regular expressions or Python expressions.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_0

LANGUAGE: VisiData
CODE:
```
s t u
```

LANGUAGE: VisiData
CODE:
```
gs gt gu
```

LANGUAGE: VisiData
CODE:
```
| \ *regex*
```

LANGUAGE: VisiData
CODE:
```
g| g\ *regex*
```

LANGUAGE: VisiData
CODE:
```
z| z\ *expr*
```

LANGUAGE: VisiData
CODE:
```
,
```

LANGUAGE: VisiData
CODE:
```
g,
```

----------------------------------------

TITLE: Applying Multiple Inline Attributes and Clearing (VisiData Python)
DESCRIPTION: This example illustrates applying multiple inline display attributes within a single string. It underlines "Note:" and then clears the last attribute with `[/]` before applying the `color_error` to `vd.motd`.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/colors.md#_snippet_4

LANGUAGE: Python
CODE:
```
options.disp_menu_fmt = "[:underline]Note:[/] [:error]{vd.motd}"
```

----------------------------------------

TITLE: Prompting User Input and Displaying Status in VisiData (Python)
DESCRIPTION: This Python example illustrates two uses of `vd.input`: first, to securely prompt for a password with `display=False`, and second, to prompt for general text, pre-filling the input field with `cursorDisplay`. The result of the second input is then displayed in the VisiData status bar using `vd.status`.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/interface.rst#_snippet_1

LANGUAGE: Python
CODE:
```
passwd = vd.input("password: ", display=False)

# initial value is the formatted value under the cursor
vd.status(vd.input("text to show: ", value=cursorDisplay))
```

----------------------------------------

TITLE: Contracting (Unexpanding) Current Column in VisiData
DESCRIPTION: The `)` command in VisiData reverses the expansion of the current column, collapsing previously expanded nested data back into its original single-column representation. This effectively 'unexpands' the column.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_21

LANGUAGE: VisiData
CODE:
```
)
```

----------------------------------------

TITLE: Hiding Current Column with Hyphen in VisiData
DESCRIPTION: This command hides the currently selected column in VisiData. It's a quick way to remove a column from view without navigating to the Columns sheet.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_1

LANGUAGE: VisiData Commands
CODE:
```
`-` (hyphen) to hide the current column.
```

----------------------------------------

TITLE: Formatting Clickable URLs in VisiData
DESCRIPTION: This snippet demonstrates VisiData's internal display attribute syntax for creating clickable URLs. It formats the enclosed <text> to become a hyperlink that opens in the user's default browser ($BROWSER) when clicked within VisiData.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/style.rst#_snippet_0

LANGUAGE: VisiData Attribute Syntax
CODE:
```
[:onclick <url>]<text>[/]
```

----------------------------------------

TITLE: Batch Specifying Column Types in VisiData
DESCRIPTION: This method allows applying a specific data type to multiple selected columns simultaneously from the Columns sheet. It streamlines the process of typing several columns at once, improving efficiency for large datasets.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_6

LANGUAGE: VisiData Commands
CODE:
```
1. Press `Shift+C` to open the **Columns sheet**.
2. Press `s` or `t` to select the rows referencing the columns you wish to type.
3. Type `g` followed by the any of the above typing keystrokes to set the type for all selected columns on the source sheet.
```

----------------------------------------

TITLE: Sorting by Multiple Columns (Key Columns) - VisiData Keybindings
DESCRIPTION: This method describes how to sort data based on multiple columns by designating them as key columns in VisiData. Once columns are marked as keys, a single command sorts by all designated key columns.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_12

LANGUAGE: VisiData Keybindings
CODE:
```
!
```

LANGUAGE: VisiData Keybindings
CODE:
```
g[ or g]
```

----------------------------------------

TITLE: Sorting by Multiple Columns (Additive) - VisiData Keybindings
DESCRIPTION: This alternative method for multi-column sorting in VisiData involves sorting columns sequentially. After sorting the first column, subsequent columns are sorted using commands that add to the existing sort criteria.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_13

LANGUAGE: VisiData Keybindings
CODE:
```
[ or ]
```

LANGUAGE: VisiData Keybindings
CODE:
```
z[ or z]
```

----------------------------------------

TITLE: Unhiding Columns via Columns Sheet in VisiData
DESCRIPTION: This method allows unhiding specific columns by setting their width to a positive number from the Columns sheet. It's used to restore previously hidden columns individually or in groups.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_4

LANGUAGE: VisiData Commands
CODE:
```
1. Press `Shift+C` on the source sheet to open its **Columns sheet**.
2. Move the cursor right to the **width** column.
3. Move the cursor down to the row which represents the column you wish to unhide. Currently, that cell should contain the value **0**.
4. Press `e` followed by a *positive number* to set the width.
5. Press `q` to return to the source sheet.
```

----------------------------------------

TITLE: Setting Default Date Format in VisiData (Python)
DESCRIPTION: This snippet configures the default display format for all date-typed columns to 'month/day/year' (`%m/%d/%Y`) by setting the `disp_date_fmt` option in the `~/.visidatarc` file. This ensures consistent date presentation across sessions.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_9

LANGUAGE: Python
CODE:
```
options.disp_date_fmt = '%m/%d/%Y'
```

----------------------------------------

TITLE: Getting User Input with VisiData.input (Python)
DESCRIPTION: This function prompts the user for a line of input on the status line. It supports history management based on the 'type' parameter and can default to the last history item if `defaultLast` is true. It returns the input as a string.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/design/232-input.md#_snippet_0

LANGUAGE: Python
CODE:
```
VisiData.input(prompt, type='', defaultLast=False, **editargs) -> str:
```

----------------------------------------

TITLE: Enabling Text Wrapping (OptionsSheet) - VisiData Keybindings
DESCRIPTION: This snippet describes how to enable text wrapping for TextSheets using VisiData's interactive OptionsSheet. It involves navigating the options menu to set the 'wrap' option to True and then reloading the sheet.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_15

LANGUAGE: VisiData Keybindings
CODE:
```
Shift+O
```

LANGUAGE: VisiData Keybindings
CODE:
```
Enter
```

LANGUAGE: VisiData Keybindings
CODE:
```
q
```

LANGUAGE: VisiData Keybindings
CODE:
```
Ctrl+R
```

----------------------------------------

TITLE: Hiding Columns via Columns Sheet in VisiData
DESCRIPTION: This method allows hiding specific columns by setting their width to zero from the Columns sheet. It provides a more controlled way to manage column visibility for multiple columns or specific ones.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_2

LANGUAGE: VisiData Commands
CODE:
```
1. Press `Shift+C` on the source sheet to open its **Columns sheet**.
2. Move the cursor right to the **width** column.
3. Move the cursor down to the row which represents the column you wish to hide.
4. Press `e` followed by `0` to set the width for that column to **0**.
5. Press `q` to return to the source sheet.
```

----------------------------------------

TITLE: Replacing Text with Regex in VisiData
DESCRIPTION: The `*` command in VisiData performs text replacement. It takes a regex pattern and a replacement string (which can include backreferences like `\1`) to substitute matching text in the current column. The `g*` variant performs the transformation in-place.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_15

LANGUAGE: VisiData
CODE:
```
*
```

----------------------------------------

TITLE: Adding a New Custom Theme (VisiData Python)
DESCRIPTION: This Python snippet shows how to define and add a new custom theme named 'awesome' to VisiData's `vd.themes` dictionary. It includes examples of setting default colors, key column colors, and edit cell colors.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/colors.md#_snippet_9

LANGUAGE: Python
CODE:
```
vd.themes['awesome'] = dict(
        color_default      = 'black on white',  # the default fg and bg colors
        color_key_col      = '20 blue',   # color of key columns
        color_edit_cell    = '234 black',     # cell color to use when editing cell
        # ... etc
    )
```

----------------------------------------

TITLE: Creating VisiData Local Plugins Directory (Shell)
DESCRIPTION: This shell command creates the `plugins` subdirectory within the user's VisiData configuration directory (`~/.visidata/`). The `-p` flag ensures that parent directories are created if they don't already exist, making it safe to run multiple times.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/plugins.md#_snippet_1

LANGUAGE: Shell
CODE:
```
mkdir -p ~/.visidata/plugins
```

----------------------------------------

TITLE: Disabling VisiData Plugin Autoloading (Shell)
DESCRIPTION: This command-line argument for `vd` (VisiData) disables the automatic loading of plugins installed via pip. While it prevents autoloading, plugins explicitly imported in the `.visidatarc` file will still be loaded, offering granular control over plugin activation.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/plugins.md#_snippet_4

LANGUAGE: Shell
CODE:
```
vd --plugins-autoload=False
```

----------------------------------------

TITLE: Sorting Date Column Chronologically - VisiData Keybindings
DESCRIPTION: This snippet explains how to sort a date column chronologically in VisiData. The process involves setting the column's data type to date, followed by applying the ascending sort command.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_11

LANGUAGE: VisiData Keybindings
CODE:
```
@
```

LANGUAGE: VisiData Keybindings
CODE:
```
]
```

----------------------------------------

TITLE: Hiding a Column by Default in VisiData (Python)
DESCRIPTION: This snippet shows how to hide a specific column (e.g., 'nCols' on the 'SheetsSheet') by setting its `width` attribute to `0` within the `knownCols` configuration in `~/.visidatarc`. This allows for customizing the default display of VisiData sheets.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_8

LANGUAGE: Python
CODE:
```
SheetsSheet.knownCols.nCols.width = 0
```

----------------------------------------

TITLE: Defining and Using a VisiData Option (Python)
DESCRIPTION: This snippet demonstrates how to define a new VisiData option using `vd.option` and integrate it into a custom command. The `disp_hello` option is defined with a default string value and a description. The `hello-world` command, triggered by pressing '1', then displays the current value of this option in the status bar. This allows users to configure the displayed text.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/options.rst#_snippet_0

LANGUAGE: Python
CODE:
```
vd.option('disp_hello', 'Hello world!', 'string to display for hello-world command')

BaseSheet.addCommand('1', 'hello-world', 'status(options.disp_hello)')
```

----------------------------------------

TITLE: Adjusting Row Height and Cell Viewing - VisiData Keybindings
DESCRIPTION: This snippet details commands for adjusting row height to display full content and for viewing/editing cell contents externally in VisiData. Toggling multi-line rows has limitations, such as preventing paging.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_14

LANGUAGE: VisiData Keybindings
CODE:
```
v
```

LANGUAGE: VisiData Keybindings
CODE:
```
e
```

LANGUAGE: VisiData Keybindings
CODE:
```
Ctrl+O
```

----------------------------------------

TITLE: Defining Global Options in VisiData
DESCRIPTION: Shows the function signature for adding a global option in VisiData, including its name, default value, and a help string.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/design/169-settings.md#_snippet_8

LANGUAGE: Python
CODE:
```
option(optname, default, helpstr)
```

----------------------------------------

TITLE: Configuring VisiData Null Value Option (Python)
DESCRIPTION: This example shows how to set the `options.null_value` in VisiData to a non-string type, such as a float or a date object. This allows VisiData to treat specific values (e.g., `0.0` or `date('1980-01-01')`) as nulls in addition to Python `None`.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/columns.rst#_snippet_2

LANGUAGE: Python
CODE:
```
options.null_value = 0.0
options.null_value = date("1980-01-01")
```

----------------------------------------

TITLE: Expanding All Visible Columns Fully in VisiData
DESCRIPTION: The `g(` command in VisiData expands all currently visible columns that contain nested data, promoting their child values into new top-level columns. This command performs a full expansion without prompting for depth.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_18

LANGUAGE: VisiData
CODE:
```
g(
```

----------------------------------------

TITLE: Implementing a SAS7BDAT File Loader in VisiData
DESCRIPTION: This example provides a complete VisiData loader for SAS dataset files (`.sas7bdat`), leveraging the `sas7bdat` Python package. It defines a `SasSheet` class that handles file parsing, column definition, and row iteration, showcasing the use of `@VisiData.api` and the `iterload` method for custom data sources.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/loaders.rst#_snippet_7

LANGUAGE: Python
CODE:
```
    from visidata import Sheet, ItemColumn, Progress

    @VisiData.api
    def open_sas7bdat(vd, p):
        return SasSheet(p.base_stem, source=p)

    class SasSheet(Sheet):
        def iterload(self):
            import sas7bdat
            SASTypes = { 'string': str, 'number': float, }

            self.dat = sas7bdat.SAS7BDAT(str(self.source),
                                         skip_header=True,
                                         log_level=logging.CRITICAL)

            self.columns = []
            for col in self.dat.columns:
                self.addColumn(ItemColumn(col.name.decode('utf-8'),
                                         col.col_id,
                                         type=SASTypes.get(col.type, anytype)))

            with self.dat as fp:
                yield from Progress(fp, total=self.dat.properties.row_count)
```

----------------------------------------

TITLE: Building Galcon Server Docker Image (Shell)
DESCRIPTION: This command builds the Docker image for the Galactic Conquest server. It uses `bluebird_docker` as an SSH deploy key for permissions and tags the image as `galcon-server`. The build context is the current directory.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/galcon/README.md#_snippet_2

LANGUAGE: Shell
CODE:
```
sudo docker build --build-arg SSH_PRIVATE_KEY="$(cat bluebird_docker)" -t galcon-server -f Dockerfile.galcon-server .
```

----------------------------------------

TITLE: Initializing Placeholder Columns - VisiData Python
DESCRIPTION: This line initializes a class-level `columns` attribute with a single placeholder `ColumnItem`. While the actual columns are dynamically determined from the TSV file's header row during the `reload()` method, this initial setup helps make the sheet feel more responsive during its initial loading phase.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/viewtsv.md#_snippet_3

LANGUAGE: Python
CODE:
```
columns = [ColumnItem('tsv', 0)]
```

----------------------------------------

TITLE: Rebinding Floatsi Type Key for Locale (Python)
DESCRIPTION: This Python snippet, for `~/.visidatarc`, rebinds the 'z%' key from its default 'type-floatsi' action to 'type-floatlocale'. This provides an alternative key binding for `type-floatlocale` (which handles comma decimal separators) if the user prefers not to rebind the '%' key.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_12

LANGUAGE: Python
CODE:
```
Sheet.unbindkey('z%')
Sheet.bindkey('z%', 'type-floatlocale')
```

----------------------------------------

TITLE: Initializing ZSH Completions (Shell)
DESCRIPTION: Initializes the ZSH completion system, loading new completion definitions and ensuring that the shell recognizes the recently added VisiData completions.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/shell.md#_snippet_5

LANGUAGE: Shell
CODE:
```
compinit
```

----------------------------------------

TITLE: Building Galcon Client Docker Image (Shell)
DESCRIPTION: This command builds the Docker image for the Galactic Conquest client. It uses `bluebird_docker` as an SSH deploy key for permissions and tags the image as `galcon-client`. The build context is the current directory.

SOURCE: https://github.com/saulpw/visidata/blob/develop/visidata/apps/galcon/README.md#_snippet_5

LANGUAGE: Shell
CODE:
```
sudo docker build --build-arg SSH_PRIVATE_KEY="$(cat bluebird_docker)" -t galcon-client -f Dockerfile.galcon-client .
```

----------------------------------------

TITLE: Setting Default Date Format via Command Line (Shell)
DESCRIPTION: This shell command demonstrates how to set the default display format for all date-typed columns to 'month/day/year' (`%m/%d/%Y`) for the current VisiData session by passing the `--disp-date-fmt` argument at launch. This provides a quick, session-specific formatting override.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_10

LANGUAGE: Shell
CODE:
```
vd --disp-date-fmt='%m/%d/%Y'
```

----------------------------------------

TITLE: Listing Option Values in VisiData
DESCRIPTION: Demonstrates how to obtain a list of all option values, either for a specific sheet or globally.

SOURCE: https://github.com/saulpw/visidata/blob/develop/dev/design/169-settings.md#_snippet_12

LANGUAGE: Python
CODE:
```
Sheet.options.values()
options.values()
```

----------------------------------------

TITLE: Implementing iterload() for SequenceSheet with Dynamic Columns in Python
DESCRIPTION: This example shows how to implement `iterload()` for a `SequenceSheet` when the `rowdef` is a list and columns are dynamic. It iterates through a data source, parses each item, and yields the result, allowing `SequenceSheet` to automatically create columns based on the yielded sequence of values.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/loaders.rst#_snippet_5

LANGUAGE: Python
CODE:
```
class FooSheet(SequenceSheet):
        rowtype = 'foobits'  # rowdef: a list, which is a sequence of values

        def iterload(self):
            with foolib.iterfoo(self.source.open_text() as f:
                r = foolib.parse(bar)
                yield r
```

----------------------------------------

TITLE: In-place Text Replacement in VisiData
DESCRIPTION: The `g*` command in VisiData is a variant of the `*` command that performs text replacement directly within the current column, modifying the original data rather than creating a new column. It follows the same regex and replacement string input process.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_16

LANGUAGE: VisiData
CODE:
```
g*
```

----------------------------------------

TITLE: Connecting to PostgreSQL Database with VisiData
DESCRIPTION: This command establishes a connection to a PostgreSQL database using VisiData. It requires the username, password, hostname, port, and database name to be provided in the URL format. VisiData will then open the specified database for interaction.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/formats.md#_snippet_4

LANGUAGE: Shell
CODE:
```
vd postgres://username:password@hostname:port/database
```

----------------------------------------

TITLE: Copying and Pasting Multiple Rows - VisiData Keybindings
DESCRIPTION: This snippet outlines the sequence of VisiData keybindings required to select, copy, and paste multiple rows. It leverages VisiData's universal paste mechanism, which creates new rows and fills them positionally from the copied data, requiring awareness of column order.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_8

LANGUAGE: VisiData Keybindings
CODE:
```
s/t
```

LANGUAGE: VisiData Keybindings
CODE:
```
gy
```

LANGUAGE: VisiData Keybindings
CODE:
```
p/Shift+P
```

----------------------------------------

TITLE: Rebinding Float Type Key for Locale (Python)
DESCRIPTION: This Python snippet, intended for `~/.visidatarc`, rebinds the '%' key from its default 'type-float' action to 'type-floatlocale'. This allows users to quickly type columns as `floatlocale`, which supports comma decimal separators, after setting the `LC_NUMERIC` environment variable.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_11

LANGUAGE: Python
CODE:
```
Sheet.unbindkey('%')
Sheet.bindkey('%', 'type-floatlocale')
```

----------------------------------------

TITLE: Extracting Data with Regex Capture Groups in VisiData
DESCRIPTION: The `;` command in VisiData generates new columns from the current column by extracting content that matches regex capture groups. New columns are named by index or capture group names, using `options.default_sample_size` (default: 100) rows for sampling.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_14

LANGUAGE: VisiData
CODE:
```
;
```

----------------------------------------

TITLE: Implementing a Custom VisiData URL Scheme Loader (Python)
DESCRIPTION: This Python function demonstrates how to define a custom URL scheme loader for VisiData. When VisiData encounters a URL starting with 'foo://', it invokes `openurl_foo`, passing a `UrlPath` object `p` and an optional `filetype`. The function then uses `openSource` with a `FooPath` object derived from the URL to process the data, effectively allowing VisiData to handle custom URL types.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/loaders.rst#_snippet_12

LANGUAGE: Python
CODE:
```
def openurl_foo(p, filetype=None):
    return openSource(FooPath(p.url), filetype=filetype)
```

----------------------------------------

TITLE: Expanding Current Column with Nested Data in VisiData
DESCRIPTION: The `(` command in VisiData expands the current column if it contains nested data structures like JSON objects or arrays, promoting their child values into new top-level columns. It samples up to `options.default_sample_size` rows around the cursor.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_17

LANGUAGE: VisiData
CODE:
```
(
```

----------------------------------------

TITLE: Sorting Numerical Column Descending - VisiData Keybindings
DESCRIPTION: This snippet details the steps to sort a numerical column from highest to lowest in VisiData. It requires first setting the column's data type to integer or float before applying the descending sort command.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/rows.md#_snippet_10

LANGUAGE: VisiData Keybindings
CODE:
```
#
```

LANGUAGE: VisiData Keybindings
CODE:
```
%
```

LANGUAGE: VisiData Keybindings
CODE:
```
[
```

----------------------------------------

TITLE: Expanding Current Column to Specific Depth in VisiData
DESCRIPTION: The `z(` command in VisiData expands the current column's nested data to a user-specified depth. After invoking the command, VisiData will prompt for the desired expansion depth, allowing granular control over the new columns created.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_19

LANGUAGE: VisiData
CODE:
```
z(
```

----------------------------------------

TITLE: Specifying Individual Column Types in VisiData
DESCRIPTION: This section lists commands for assigning specific data types to columns in VisiData. Correct typing is crucial for accurate data interpretation and calculations, especially for numerical and date values, preventing errors from string misinterpretations.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/columns.md#_snippet_5

LANGUAGE: VisiData Commands
CODE:
```
Command    Type
--------- --------
` ~`      string
` #`      int
` %`      float
` $`      currency
` @`      date
`z#`      vlen
`z~`      anytype
```

----------------------------------------

TITLE: Overriding and Calling Original Functions with Extensible.api in Python
DESCRIPTION: This example shows how to override an existing member function, such as `addRow` on a `Sheet`, using `@Sheet.api`. To execute the original function's logic after performing custom operations, access it via `func.__wrapped__`, passing the instance and arguments.

SOURCE: https://github.com/saulpw/visidata/blob/develop/docs/api/extensible.rst#_snippet_1

LANGUAGE: Python
CODE:
```
@Sheet.api
def addRow(sheet, row):
    # do something first
    addRow.__wrapped__(sheet, row)

....

sheet.addRow(row)
```