Skip to content
Merged
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
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,25 +75,26 @@ This creates a config file at `~/.config/work-reporter/config.yaml` with a templ
Create a config file at `~/.config/work-reporter/config.yaml`:

```yaml
# Active source and destination (choose one of each)
# Active Source type: superProductivity | plainJson
source: superProductivity

# Active Destination type: youTrack | somethingElse
destination: youTrack

# Configuration for each source type
sources:
# SuperProductivity sync file path
superProductivity:
syncFilePath: ~/.config/superproductivity/__meta_

# Or use a plain JSON file as a source
plainJson:
filePath: ~/worklogs.json
superProductivity:
syncFilePath: ~/.config/superproductivity/__meta_
plainJson:
filePath: /path/to/time-entries.json

# Configuration for each destination type
destinations:
youTrack:
# Your YouTrack instance URL
url: https://youtrack.example.com
# Permanent token for authentication (see below)
token: perm-your-permanent-token
youTrack:
# Your YouTrack instance URL
url: https://youtrack.example.com
# Permanent token for authentication
token: your-api-token
```

#### 🔑 Getting a YouTrack Token
Expand All @@ -108,7 +109,7 @@ destinations:
1. Open SuperProductivity → **Settings** → **Sync & Export** → **Sync**
2. Enable **Enable Syncing**
3. Choose **Sync folder path**
4. Paste the same path into `syncFilePath` in your config file
4. Paste the same path into `sources.superProductivity.syncFilePath` in your config file

---

Expand Down
14 changes: 9 additions & 5 deletions src/Cli/InitCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,25 @@ class InitCommand extends Command
# Work Reporter configuration file
# Documentation: https://github.com/igancev/work-reporter

# Source type: superProductivity | plainJson
source: plainJson
# Active Source type: superProductivity | plainJson
source: superProductivity

# Destination type: youTrack
# Active Destination type: youTrack | somethingElse
destination: youTrack

# Configuration for each source type
sources:
superProductivity:
syncFilePath: ~/.config/superproductivity/__meta_
plainJson:
filePath: /path/to/time-entries.json
# superProductivity:
# syncFilePath: /path/to/sync-file.json

# Configuration for each destination type
destinations:
youTrack:
# Your YouTrack instance URL
url: https://youtrack.example.com
# Permanent token for authentication
token: your-api-token
YAML;

Expand Down
Loading