# nomctl fs

```text
File Store commands

Usage: nomctl fs <COMMAND>

Commands:
  drive      Drive management commands
  ls         List files and directories in a Nominal Drive
  put        Put a local file in a drive
  download   Download a file from a drive to a local file
  mv         Move a file to a new path in a drive
  rm         Remove a file from a drive
  revisions  List the revision history of a file in a drive
  restore    Restore a past revision of a file in a drive
  help       Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help
```

## nomctl fs drive

```text
Drive management commands

Usage: nomctl fs drive <COMMAND>

Commands:
  list        List drives in the workspace
  create      Create a managed drive
  get         Get a drive by ID
  get-by-rid  Get a drive by RID
  rename      Change a drive's ID
  archive     Archive a drive. Archived drives are hidden from the UI but not deleted
  unarchive   Unarchive a drive, restoring its visibility in the UI
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help
```

### nomctl fs drive list

```text
List drives in the workspace

Usage: nomctl fs drive list [OPTIONS]

Options:
      --include-archived
          Include archived drives

  -h, --help
          Print help
```

### nomctl fs drive create

```text
Create a managed drive

Usage: nomctl fs drive create <ID>

Arguments:
  <ID>
          The drive ID

Options:
  -h, --help
          Print help
```

### nomctl fs drive get

```text
Get a drive by ID

Usage: nomctl fs drive get <ID>

Arguments:
  <ID>
          Drive ID

Options:
  -h, --help
          Print help
```

### nomctl fs drive get-by-rid

```text
Get a drive by RID

Usage: nomctl fs drive get-by-rid <RID>

Arguments:
  <RID>
          Drive RID

Options:
  -h, --help
          Print help
```

### nomctl fs drive rename

```text
Change a drive's ID

Usage: nomctl fs drive rename <DRIVE> <NEW_ID>

Arguments:
  <DRIVE>
          Drive ID

  <NEW_ID>
          The new drive ID

Options:
  -h, --help
          Print help
```

### nomctl fs drive archive

```text
Archive a drive. Archived drives are hidden from the UI but not deleted

Usage: nomctl fs drive archive <DRIVE>

Arguments:
  <DRIVE>
          Drive ID

Options:
  -h, --help
          Print help
```

### nomctl fs drive unarchive

```text
Unarchive a drive, restoring its visibility in the UI

Usage: nomctl fs drive unarchive <DRIVE>

Arguments:
  <DRIVE>
          Drive ID

Options:
  -h, --help
          Print help
```

## nomctl fs ls

```text
List files and directories in a Nominal Drive

Usage: nomctl fs ls [OPTIONS] <DRIVE:/PATH>

Arguments:
  <DRIVE:/PATH>
          Drive-qualified path, formatted as DRIVE:/PATH

Options:
      --include-removed
          Include removed (soft-deleted) files

  -h, --help
          Print help

Examples:
  nomctl fs ls eng:/
  nomctl fs ls eng:/telemetry
```

## nomctl fs put

```text
Put a local file in a drive

Usage: nomctl fs put <LOCAL_PATH> <DRIVE:/PATH>

Arguments:
  <LOCAL_PATH>
          Path to the local file to upload

  <DRIVE:/PATH>
          Drive-qualified destination path, formatted as DRIVE:/PATH

Options:
  -h, --help
          Print help
```

## nomctl fs download

```text
Download a file from a drive to a local file

Usage: nomctl fs download <DRIVE:/PATH> [LOCAL_PATH]

Arguments:
  <DRIVE:/PATH>
          Drive-qualified source path, formatted as DRIVE:/PATH

  [LOCAL_PATH]
          Local file to create or replace. Defaults to the source path relative to the current directory

Options:
  -h, --help
          Print help
```

## nomctl fs mv

```text
Move a file to a new path in a drive

Usage: nomctl fs mv <DRIVE:/SOURCE_PATH> </DESTINATION_PATH>

Arguments:
  <DRIVE:/SOURCE_PATH>
          Drive-qualified source path, formatted as DRIVE:/PATH

  </DESTINATION_PATH>
          Root-relative destination path within the source drive, formatted as /PATH

Options:
  -h, --help
          Print help
```

## nomctl fs rm

```text
Remove a file from a drive

Usage: nomctl fs rm <DRIVE:/PATH>

Arguments:
  <DRIVE:/PATH>
          Drive-qualified path, formatted as DRIVE:/PATH

Options:
  -h, --help
          Print help
```

## nomctl fs revisions

```text
List the revision history of a file in a drive

Usage: nomctl fs revisions <DRIVE:/PATH>

Arguments:
  <DRIVE:/PATH>
          Drive-qualified path, formatted as DRIVE:/PATH

Options:
  -h, --help
          Print help
```

## nomctl fs restore

```text
Restore a past revision of a file in a drive

Usage: nomctl fs restore <REVISION_RID> <DRIVE:/PATH>

Arguments:
  <REVISION_RID>
          Revision RID to restore (see `nomctl fs revisions`)

  <DRIVE:/PATH>
          Drive-qualified destination path, formatted as DRIVE:/PATH

Options:
  -h, --help
          Print help
```
