Skip to content

Commit 7ec39ad

Browse files
committed
Initial commit
0 parents  commit 7ec39ad

File tree

5 files changed

+1427
-0
lines changed

5 files changed

+1427
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# alfred-clockify
2+
3+
Quickly start and stop your Clockify timers from Alfred.
4+
5+
## Installation
6+
7+
After installing the workflow, you will be prompted to define its environment variables. To get started, only the Clockify API key is required — the workflow can resolve your user id and any available workspaces once the API key is configured.
8+
9+
After configuring the API key, run the workflow using the `.clockify` keyword. If your user id has not been defined, you will be prompted to install it. Select the _Setup User Account_ option to automatically resolve the user id from the provided API key.
10+
11+
Once both the API key and user id have been configured, if you have not already configured a workspace id, you will be prompted to select a workspace. Select the _Choose Workspace_ option to pick your workspace from a list.
12+
13+
## Workflow Variables
14+
15+
| Variable | Description |
16+
| :---------------------: | :-------------------------------------------------------------- |
17+
| `clockify_api_key` | Your Clockify API key. |
18+
| `clockify_user_id` | Your Clockify user id. |
19+
| `clockify_workspace_id` | The workspace id to use when creating and editing time entries. |
20+
21+
## Workflow Design
22+
23+
`alfred-clockify` is my first complex Alfred workflow. It uses JXA at its core, and leverages script-driven recursion via a single _Script Filter_ node rather than using multiple workflow nodes to perform operations. Ultimately, I think this yields a more maintainable and less redundant workflow — engaging functional workflow design.
24+
If you have any questions about this workflow or the techniques engaged, please feel free to reach-out via [e-mail](mailto:stephancasas@icloud.com) or on [Twitter](https://www.twitter.com/stephancasas)
25+
26+
## License
27+
28+
MIT — _Hell yeah, free software!_

0 commit comments

Comments
 (0)