trello-to-deck/README.md

# Trello to Deck

Migrate your Trello Board to Nextcloud Deck.

## Getting Started

- Install `trello-to-deck`:

e.g.

```bash
cargo install trello-to-deck
```

- Create a starter configuration file

```bash
trello-to-deck init
```

This will create a `trello-to-deck.toml` file in the current directory.

Edit this file to add your Trello and Nextcloud credentials.

### Import

To import your Trello Board into Nextcloud Deck, use the command:

```bash
trello-2-deck import
```

This will read the credentials from the `trello-2-deck.toml` file in the current
directory. You will prompted to select a Trello Board, then some or all of the
Lists from that Board. To begin your import, select the Nextcloud Deck Board
to add the lists and cards to.

It is recommended to create a test board to confirm importing is working as you
expect.

### Trello Credentials

To autheniticate to Trello and be able to download the attachements for each card, you need to register a Power Up as a Developer.
This is free and easy, following these instructions;

- Login to <https://trello.com/>
- Visit: <https://trello.com/power-ups/admin>
- Click *New* to create a new Power-Up/Integration
- Complete the *New Power-Up or Integration* form:
  - Power-Up or Integrtation Name: *Trello to Deck*
  - Workspace: select the workspace you went to export your boards from
  - IFrame: (ignore)
  - Email: your email
  - Support: your email
  - Author: your name
  - Click *Create*
- API Key: click *Generate a new API key* (twice)
- Copy your *API key* into your `trello-to-deck.toml` file
- To the right of the API Key, click on the *Token* link at the end of the paragraph.
- On the 'Would you like to give the following application access to your account?' page, scroll down and click *Allow*
- Copy the token into you `trello-to-deck.toml` file

### Nextcloud Credentials

To authenticate with Nextcloud Deck, you'll need to obtain the necessary credentials:

1. Log in to your Nextcloud instance
2. Go to Settings > Security
3. Under the "App passwords / devices" section, create a new app password
4. Enter a name for the device (e.g., "Trello to Deck")
5. Click "Create new app password"
6. Copy the generated username and password
7. Add these credentials to your `trello-to-deck.toml` file

### Verify configuration

Run the `check` command to validate your configuration:

```bash
trello-to-deck check
```

## Support Features

| Feature                  | Supported |
|--------------------------|-----------|
| Stacks/Lists             | y         |
| Cards                    | y         |
| Card Title               | y         |
| Card Description         | y         |
| Card Labels              | y         |
| Card Attachments (files) | y         |
| Card Attachments (links) | n         |
| Card Due Date            | y         |
| Card Assignment          | n         |