# info

## Basic queries

To view all subjects in the package, with all subject information, and in csv format

```bash
squirrel info <package> --object subject --dataset full --format csv
```

To view only a list of subject IDs in the package

```bash
squirrel info <package> --object subject
```

## Main Options

### --dataset

`--dataset <dataset>` can have one of the following values

| Dataset | Description                                                                                                                                                               |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id      | Only a list of identifiers or object names will be listed.                                                                                                                |
| basic   | Only basic columns associated. Parent object IDs will also be listed. For example if series is listed, then study and subject IDs will be listed.                         |
| full    | All columns associated with the object will be listed. Parent object IDs will also be listed. For example if series is listed, then study and subject IDs will be listed. |

### --format

`--format <format>` can have one of the following values

| Format | Description                                                                                                                           |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| list   | List the data in tab separated format                                                                                                 |
| csv    | List the data is comma separated (csv) format. All string fields will be quoted. This can be piped into a file using the `>` operator |

### --object

`--object <object>` can have one of the following values, which mirrors the squirrel object types

* package (default if object is not specified)
* subject
* study
* series
* experiment
* observation
* intervention
* experiment
* pipeline
* groupanalysis
* datadictionary


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.neuroinfodb.org/squirrel/getting-started/squirrel-utilities/info.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.