Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions docs/stream-cli_feeds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# stream-cli feeds

Allows you to interact with your Feeds applications

## Commands

### stream-cli feeds import-validate

Validates a JSON file for feeds import.

This command checks if the file is valid JSON format.

**Usage:**

```bash
stream-cli feeds import-validate [filename]
```

**Examples:**

```bash
# Validates a JSON feeds import file
$ stream-cli feeds import-validate feeds-data.json
```

### stream-cli feeds import

Imports feeds data from a JSON file.

This command uploads the file to S3 and initiates the import process.

**Usage:**

```bash
stream-cli feeds import [filename] --apikey [api-key]
```

**Flags:**

- `-k, --apikey string`: [required] API key for authentication
- `-m, --mode string`: [optional] Import mode. Can be upsert or insert (default "upsert")

**Examples:**

```bash
# Import feeds data with API key
$ stream-cli feeds import feeds-data.json --apikey your-api-key

# Import feeds data with custom mode
$ stream-cli feeds import feeds-data.json --apikey your-api-key --mode insert
```

### stream-cli feeds import-status

Checks the status of a feeds import operation.

You can optionally watch for completion with the --watch flag.

**Usage:**

```bash
stream-cli feeds import-status [import-id]
```

**Flags:**

- `-w, --watch`: [optional] Watch import until completion
- `-o, --output-format string`: [optional] Output format. Can be json or tree (default "json")

**Examples:**

```bash
# Check import status
$ stream-cli feeds import-status dcb6e366-93ec-4e52-af6f-b0c030ad5272

# Watch import until completion
$ stream-cli feeds import-status dcb6e366-93ec-4e52-af6f-b0c030ad5272 --watch
```
48 changes: 48 additions & 0 deletions docs/stream-cli_feeds_import-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# stream-cli feeds import-status

Checks the status of a feeds import operation.

You can optionally watch for completion with the --watch flag.

## Usage

```bash
stream-cli feeds import-status [import-id]
```

## Arguments

- `import-id`: The ID of the import operation to check

## Flags

- `-w, --watch`: [optional] Watch import until completion
- `-o, --output-format string`: [optional] Output format. Can be json or tree (default "json")

## Examples

```bash
# Check import status
$ stream-cli feeds import-status dcb6e366-93ec-4e52-af6f-b0c030ad5272

# Watch import until completion
$ stream-cli feeds import-status dcb6e366-93ec-4e52-af6f-b0c030ad5272 --watch
```

## Output Formats

- `json`: Output in JSON format (default)
- `tree`: Output in a browsable tree format

## Watch Mode

When using the `--watch` flag, the command will continuously poll the import status every 5 seconds until the import is completed or failed.

## Output

The command will output the current status of the import task, including details such as:

- Import ID
- Status (pending, running, completed, failed)
- Progress information
- Error details (if any)
32 changes: 32 additions & 0 deletions docs/stream-cli_feeds_import-validate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# stream-cli feeds import-validate

Validates a JSON file for feeds import.

This command checks if the file is valid JSON format.

## Usage

```bash
stream-cli feeds import-validate [filename]
```

## Arguments

- `filename`: Path to the JSON file to validate

## Examples

```bash
# Validates a JSON feeds import file
$ stream-cli feeds import-validate feeds-data.json
```

## Output

The command will output a success message if the file is valid JSON:

```
✅ File 'feeds-data.json' is valid JSON
```

If the file is invalid or doesn't exist, an error message will be displayed.
46 changes: 46 additions & 0 deletions docs/stream-cli_feeds_import.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# stream-cli feeds import

Imports feeds data from a JSON file.

This command uploads the file to S3 and initiates the import process.

## Usage

```bash
stream-cli feeds import [filename] --apikey [api-key]
```

## Arguments

- `filename`: Path to the JSON file to import

## Flags

- `-k, --apikey string`: [required] API key for authentication
- `-m, --mode string`: [optional] Import mode. Can be upsert or insert (default "upsert")

## Examples

```bash
# Import feeds data with API key
$ stream-cli feeds import feeds-data.json --apikey your-api-key

# Import feeds data with custom mode
$ stream-cli feeds import feeds-data.json --apikey your-api-key --mode insert
```

## Import Modes

- `upsert`: Updates existing feeds and creates new ones (default)
- `insert`: Only creates new feeds, fails if feed already exists

## Output

The command will output the import task details including the import ID:

```
✅ Import started successfully
Import ID: dcb6e366-93ec-4e52-af6f-b0c030ad5272
```

The full import task object will also be printed in the specified output format.
Loading
Loading