feat: Extended Deeplinks + Raycast Extension (#1540)#1582
Open
divol89 wants to merge 1 commit intoCapSoftware:mainfrom
Open
feat: Extended Deeplinks + Raycast Extension (#1540)#1582divol89 wants to merge 1 commit intoCapSoftware:mainfrom
divol89 wants to merge 1 commit intoCapSoftware:mainfrom
Conversation
Add comprehensive deeplinks support for Cap desktop app: New deeplink actions: - PauseRecording: pause active recording - ResumeRecording: resume paused recording - TogglePauseRecording: toggle pause/resume state - SwitchMicrophone: change microphone input - SwitchCamera: change camera input Raycast Extension: - Start/Stop/Pause/Resume/Toggle recording commands - Switch Microphone command with device selection - Switch Camera command with device selection - Open Settings command - Preferences for recording mode and system audio Documentation: - Complete API docs in apps/desktop/docs/DEEPLINKS.md - Extension README with usage instructions Closes CapSoftware#1540
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
+18
to
+21
| // In a future iteration, this could fetch available cameras from Cap | ||
| // For now, we provide the basic options | ||
| setIsLoading(false); | ||
| }, []); |
Contributor
There was a problem hiding this comment.
Inline comments disallowed
This file introduces // comments in the useEffect block, which violates the repo-wide “NO CODE COMMENTS” rule (see CLAUDE.md/AGENTS.md). Please remove these comments and keep the code self-explanatory via naming/structure.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Prompt To Fix With AI
This is a comment left during a code review.
Path: extensions/raycast/cap/src/switch-camera.tsx
Line: 18:21
Comment:
**Inline comments disallowed**
This file introduces `//` comments in the `useEffect` block, which violates the repo-wide “NO CODE COMMENTS” rule (see CLAUDE.md/AGENTS.md). Please remove these comments and keep the code self-explanatory via naming/structure.
<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
+27
to
+29
| await sendDeepLink("switch_camera", { | ||
| camera, | ||
| }); |
Contributor
There was a problem hiding this comment.
Default option disables camera
cameraId === "default" is currently mapped to null, but the deeplink contract/docs use null to disable the camera. This makes “System Default” behave the same as “No Camera”. Consider either removing the “System Default” option or mapping it to an explicit identifier that Cap treats as default (so null remains reserved for disable). Also affects microphone switching.
Also appears in: extensions/raycast/cap/src/switch-microphone.tsx (default -> null mapping).
Prompt To Fix With AI
This is a comment left during a code review.
Path: extensions/raycast/cap/src/switch-camera.tsx
Line: 27:29
Comment:
**Default option disables camera**
`cameraId === "default"` is currently mapped to `null`, but the deeplink contract/docs use `null` to *disable* the camera. This makes “System Default” behave the same as “No Camera”. Consider either removing the “System Default” option or mapping it to an explicit identifier that Cap treats as default (so `null` remains reserved for disable). Also affects microphone switching.
Also appears in: `extensions/raycast/cap/src/switch-microphone.tsx` (default -> null mapping).
How can I resolve this? If you propose a fix, please make it concise.![tembo[bot]](https://avatars.githubusercontent.com/in/1223475?s=60&v=4){kind=small}
Comment on lines
+28
to
+33
| const capture_mode = | ||
| options.captureMode === "screen" && options.screenName | ||
| ? { Screen: options.screenName } | ||
| : options.captureMode === "window" && options.windowName | ||
| ? { Window: options.windowName } | ||
| : { Screen: "Primary" }; |
There was a problem hiding this comment.
CaptureMode in the Tauri deeplink code is #[serde(rename_all = "snake_case")], so the JSON for capture_mode should use screen/window keys (not Screen/Window), otherwise start_recording won’t deserialize.
Suggested change
| const capture_mode = | |
| options.captureMode === "screen" && options.screenName | |
| ? { Screen: options.screenName } | |
| : options.captureMode === "window" && options.windowName | |
| ? { Window: options.windowName } | |
| : { Screen: "Primary" }; | |
| const capture_mode = | |
| options.captureMode === "screen" && options.screenName | |
| ? { screen: options.screenName } | |
| : options.captureMode === "window" && options.windowName | |
| ? { window: options.windowName } | |
| : { screen: "Primary" }; |
Comment on lines
+13
to
+19
| await sendDeepLink("start_recording", { | ||
| capture_mode: { Screen: "Primary" }, | ||
| camera: null, | ||
| mic_label: null, | ||
| capture_system_audio: preferences.captureSystemAudio ?? false, | ||
| mode: preferences.recordingMode ?? "studio", | ||
| }); |
There was a problem hiding this comment.
Same capture_mode key casing issue here (screen not Screen).
Suggested change
| await sendDeepLink("start_recording", { | |
| capture_mode: { Screen: "Primary" }, | |
| camera: null, | |
| mic_label: null, | |
| capture_system_audio: preferences.captureSystemAudio ?? false, | |
| mode: preferences.recordingMode ?? "studio", | |
| }); | |
| await sendDeepLink("start_recording", { | |
| capture_mode: { screen: "Primary" }, | |
| camera: null, | |
| mic_label: null, | |
| capture_system_audio: preferences.captureSystemAudio ?? false, | |
| mode: preferences.recordingMode ?? "studio", | |
| }); |
Comment on lines
+29
to
+31
| - `capture_mode` (object): Screen or Window selection | ||
| - `Screen`: `{ "Screen": "Screen Name" }` | ||
| - `Window`: `{ "Window": "Window Name" }` |
There was a problem hiding this comment.
Minor but important: the capture_mode enum is deserialized with snake_case, so the docs should show screen/window keys (otherwise copy/paste examples won’t work).
Suggested change
| - `capture_mode` (object): Screen or Window selection | |
| - `Screen`: `{ "Screen": "Screen Name" }` | |
| - `Window`: `{ "Window": "Window Name" }` | |
| - `capture_mode` (object): Screen or Window selection | |
| - `screen`: `{ "screen": "Screen Name" }` | |
| - `window`: `{ "window": "Window Name" }` |
Comment on lines
+13
to
+78
| "commands": [ | ||
| { | ||
| "name": "start-recording", | ||
| "title": "Start Recording", | ||
| "subtitle": "Cap", | ||
| "description": "Start a new screen recording with Cap", | ||
| "mode": "no-view", | ||
| "icon": "record-icon.png" | ||
| }, | ||
| { | ||
| "name": "stop-recording", | ||
| "title": "Stop Recording", | ||
| "subtitle": "Cap", | ||
| "description": "Stop the current recording", | ||
| "mode": "no-view", | ||
| "icon": "stop-icon.png" | ||
| }, | ||
| { | ||
| "name": "pause-recording", | ||
| "title": "Pause Recording", | ||
| "subtitle": "Cap", | ||
| "description": "Pause the current recording", | ||
| "mode": "no-view", | ||
| "icon": "pause-icon.png" | ||
| }, | ||
| { | ||
| "name": "resume-recording", | ||
| "title": "Resume Recording", | ||
| "subtitle": "Cap", | ||
| "description": "Resume the paused recording", | ||
| "mode": "no-view", | ||
| "icon": "resume-icon.png" | ||
| }, | ||
| { | ||
| "name": "toggle-pause", | ||
| "title": "Toggle Pause", | ||
| "subtitle": "Cap", | ||
| "description": "Toggle pause/resume for the current recording", | ||
| "mode": "no-view", | ||
| "icon": "toggle-icon.png" | ||
| }, | ||
| { | ||
| "name": "switch-microphone", | ||
| "title": "Switch Microphone", | ||
| "subtitle": "Cap", | ||
| "description": "Switch to a different microphone", | ||
| "mode": "view", | ||
| "icon": "mic-icon.png" | ||
| }, | ||
| { | ||
| "name": "switch-camera", | ||
| "title": "Switch Camera", | ||
| "subtitle": "Cap", | ||
| "description": "Switch to a different camera", | ||
| "mode": "view", | ||
| "icon": "camera-icon.png" | ||
| }, | ||
| { | ||
| "name": "open-settings", | ||
| "title": "Open Settings", | ||
| "subtitle": "Cap", | ||
| "description": "Open Cap settings", | ||
| "mode": "no-view", | ||
| "icon": "settings-icon.png" | ||
| } | ||
| ], |
There was a problem hiding this comment.
assets/ only contains cap-icon.png, but the commands reference record-icon.png, stop-icon.png, etc. Raycast will fail to load missing icons. Quick fix is to point them all at cap-icon.png until the specific icons are added.
Suggested change
| "commands": [ | |
| { | |
| "name": "start-recording", | |
| "title": "Start Recording", | |
| "subtitle": "Cap", | |
| "description": "Start a new screen recording with Cap", | |
| "mode": "no-view", | |
| "icon": "record-icon.png" | |
| }, | |
| { | |
| "name": "stop-recording", | |
| "title": "Stop Recording", | |
| "subtitle": "Cap", | |
| "description": "Stop the current recording", | |
| "mode": "no-view", | |
| "icon": "stop-icon.png" | |
| }, | |
| { | |
| "name": "pause-recording", | |
| "title": "Pause Recording", | |
| "subtitle": "Cap", | |
| "description": "Pause the current recording", | |
| "mode": "no-view", | |
| "icon": "pause-icon.png" | |
| }, | |
| { | |
| "name": "resume-recording", | |
| "title": "Resume Recording", | |
| "subtitle": "Cap", | |
| "description": "Resume the paused recording", | |
| "mode": "no-view", | |
| "icon": "resume-icon.png" | |
| }, | |
| { | |
| "name": "toggle-pause", | |
| "title": "Toggle Pause", | |
| "subtitle": "Cap", | |
| "description": "Toggle pause/resume for the current recording", | |
| "mode": "no-view", | |
| "icon": "toggle-icon.png" | |
| }, | |
| { | |
| "name": "switch-microphone", | |
| "title": "Switch Microphone", | |
| "subtitle": "Cap", | |
| "description": "Switch to a different microphone", | |
| "mode": "view", | |
| "icon": "mic-icon.png" | |
| }, | |
| { | |
| "name": "switch-camera", | |
| "title": "Switch Camera", | |
| "subtitle": "Cap", | |
| "description": "Switch to a different camera", | |
| "mode": "view", | |
| "icon": "camera-icon.png" | |
| }, | |
| { | |
| "name": "open-settings", | |
| "title": "Open Settings", | |
| "subtitle": "Cap", | |
| "description": "Open Cap settings", | |
| "mode": "no-view", | |
| "icon": "settings-icon.png" | |
| } | |
| ], | |
| "commands": [ | |
| { | |
| "name": "start-recording", | |
| "title": "Start Recording", | |
| "subtitle": "Cap", | |
| "description": "Start a new screen recording with Cap", | |
| "mode": "no-view", | |
| "icon": "cap-icon.png" | |
| }, | |
| { | |
| "name": "stop-recording", | |
| "title": "Stop Recording", | |
| "subtitle": "Cap", | |
| "description": "Stop the current recording", | |
| "mode": "no-view", | |
| "icon": "cap-icon.png" | |
| }, | |
| { | |
| "name": "pause-recording", | |
| "title": "Pause Recording", | |
| "subtitle": "Cap", | |
| "description": "Pause the current recording", | |
| "mode": "no-view", | |
| "icon": "cap-icon.png" | |
| }, | |
| { | |
| "name": "resume-recording", | |
| "title": "Resume Recording", | |
| "subtitle": "Cap", | |
| "description": "Resume the paused recording", | |
| "mode": "no-view", | |
| "icon": "cap-icon.png" | |
| }, | |
| { | |
| "name": "toggle-pause", | |
| "title": "Toggle Pause", | |
| "subtitle": "Cap", | |
| "description": "Toggle pause/resume for the current recording", | |
| "mode": "no-view", | |
| "icon": "cap-icon.png" | |
| }, | |
| { | |
| "name": "switch-microphone", | |
| "title": "Switch Microphone", | |
| "subtitle": "Cap", | |
| "description": "Switch to a different microphone", | |
| "mode": "view", | |
| "icon": "cap-icon.png" | |
| }, | |
| { | |
| "name": "switch-camera", | |
| "title": "Switch Camera", | |
| "subtitle": "Cap", | |
| "description": "Switch to a different camera", | |
| "mode": "view", | |
| "icon": "cap-icon.png" | |
| }, | |
| { | |
| "name": "open-settings", | |
| "title": "Open Settings", | |
| "subtitle": "Cap", | |
| "description": "Open Cap settings", | |
| "mode": "no-view", | |
| "icon": "cap-icon.png" | |
| } | |
| ], |
Comment on lines
+1
to
+30
| import { List, ActionPanel, Action, showToast, Toast } from "@raycast/api"; | ||
| import { useState, useEffect } from "react"; | ||
| import { sendDeepLink } from "./utils"; | ||
|
|
||
| interface Microphone { | ||
| id: string; | ||
| name: string; | ||
| } | ||
|
|
||
| export default function Command() { | ||
| const [microphones, setMicrophones] = useState<Microphone[]>([ | ||
| { id: "default", name: "System Default" }, | ||
| { id: "none", name: "No Microphone" }, | ||
| ]); | ||
| const [isLoading, setIsLoading] = useState(true); | ||
|
|
||
| useEffect(() => { | ||
| // In a future iteration, this could fetch available microphones from Cap | ||
| // For now, we provide the basic options | ||
| setIsLoading(false); | ||
| }, []); | ||
|
|
||
| async function handleSwitchMicrophone(micId: string) { | ||
| try { | ||
| const micLabel = micId === "none" ? null : micId === "default" ? null : micId; | ||
|
|
||
| await sendDeepLink("switch_microphone", { | ||
| mic_label: micLabel, | ||
| }); | ||
|
|
There was a problem hiding this comment.
Right now default and none both send mic_label: null, so “System Default” ends up disabling the mic (same as “No Microphone”). Also, repo guidelines disallow code comments.
Suggested change
| import { List, ActionPanel, Action, showToast, Toast } from "@raycast/api"; | |
| import { useState, useEffect } from "react"; | |
| import { sendDeepLink } from "./utils"; | |
| interface Microphone { | |
| id: string; | |
| name: string; | |
| } | |
| export default function Command() { | |
| const [microphones, setMicrophones] = useState<Microphone[]>([ | |
| { id: "default", name: "System Default" }, | |
| { id: "none", name: "No Microphone" }, | |
| ]); | |
| const [isLoading, setIsLoading] = useState(true); | |
| useEffect(() => { | |
| // In a future iteration, this could fetch available microphones from Cap | |
| // For now, we provide the basic options | |
| setIsLoading(false); | |
| }, []); | |
| async function handleSwitchMicrophone(micId: string) { | |
| try { | |
| const micLabel = micId === "none" ? null : micId === "default" ? null : micId; | |
| await sendDeepLink("switch_microphone", { | |
| mic_label: micLabel, | |
| }); | |
| import { List, ActionPanel, Action, showToast, Toast } from "@raycast/api"; | |
| import { useState } from "react"; | |
| import { sendDeepLink } from "./utils"; | |
| interface Microphone { | |
| id: string; | |
| name: string; | |
| } | |
| export default function Command() { | |
| const [microphones] = useState<Microphone[]>([{ id: "none", name: "No Microphone" }]); | |
| const [isLoading] = useState(false); | |
| async function handleSwitchMicrophone(micId: string) { | |
| try { | |
| const micLabel = micId === "none" ? null : micId; | |
| await sendDeepLink("switch_microphone", { | |
| mic_label: micLabel, | |
| }); |
Comment on lines
+1
to
+30
| import { List, ActionPanel, Action, showToast, Toast } from "@raycast/api"; | ||
| import { useState, useEffect } from "react"; | ||
| import { sendDeepLink } from "./utils"; | ||
|
|
||
| interface Camera { | ||
| id: string; | ||
| name: string; | ||
| } | ||
|
|
||
| export default function Command() { | ||
| const [cameras, setCameras] = useState<Camera[]>([ | ||
| { id: "default", name: "System Default" }, | ||
| { id: "none", name: "No Camera" }, | ||
| ]); | ||
| const [isLoading, setIsLoading] = useState(true); | ||
|
|
||
| useEffect(() => { | ||
| // In a future iteration, this could fetch available cameras from Cap | ||
| // For now, we provide the basic options | ||
| setIsLoading(false); | ||
| }, []); | ||
|
|
||
| async function handleSwitchCamera(cameraId: string) { | ||
| try { | ||
| const camera = cameraId === "none" ? null : cameraId === "default" ? null : { DeviceID: cameraId }; | ||
|
|
||
| await sendDeepLink("switch_camera", { | ||
| camera, | ||
| }); | ||
|
|
There was a problem hiding this comment.
Same thing for camera: default and none both send camera: null, so “System Default” disables the camera. Also removes the inline comments per repo guidelines.
Suggested change
| import { List, ActionPanel, Action, showToast, Toast } from "@raycast/api"; | |
| import { useState, useEffect } from "react"; | |
| import { sendDeepLink } from "./utils"; | |
| interface Camera { | |
| id: string; | |
| name: string; | |
| } | |
| export default function Command() { | |
| const [cameras, setCameras] = useState<Camera[]>([ | |
| { id: "default", name: "System Default" }, | |
| { id: "none", name: "No Camera" }, | |
| ]); | |
| const [isLoading, setIsLoading] = useState(true); | |
| useEffect(() => { | |
| // In a future iteration, this could fetch available cameras from Cap | |
| // For now, we provide the basic options | |
| setIsLoading(false); | |
| }, []); | |
| async function handleSwitchCamera(cameraId: string) { | |
| try { | |
| const camera = cameraId === "none" ? null : cameraId === "default" ? null : { DeviceID: cameraId }; | |
| await sendDeepLink("switch_camera", { | |
| camera, | |
| }); | |
| import { List, ActionPanel, Action, showToast, Toast } from "@raycast/api"; | |
| import { useState } from "react"; | |
| import { sendDeepLink } from "./utils"; | |
| interface Camera { | |
| id: string; | |
| name: string; | |
| } | |
| export default function Command() { | |
| const [cameras] = useState<Camera[]>([{ id: "none", name: "No Camera" }]); | |
| const [isLoading] = useState(false); | |
| async function handleSwitchCamera(cameraId: string) { | |
| try { | |
| const camera = cameraId === "none" ? null : { DeviceID: cameraId }; | |
| await sendDeepLink("switch_camera", { | |
| camera, | |
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements the bounty #1540 ($200) for Cap Software.
Features Implemented
🔗 Extended Deeplinks Support
🎛️ Complete Raycast Extension (8 Commands)
📚 Documentation
Testing
Bounty
This PR closes bounty #1540 - Reward: $200
Note: This is a complete implementation ready for review.
Greptile Overview
Greptile Summary
This PR extends the desktop app’s deeplink action set (pause/resume/toggle pause, switch mic/camera) and adds a new Raycast extension under
extensions/raycast/capwith commands that generate/opencap-desktop://action?value=<json>URLs. It also adds deeplink API documentation underapps/desktop/docs/DEEPLINKS.mdto describe the available actions and parameters.Key integration point: Raycast commands build JSON payloads matching
apps/desktop/src-tauri/src/deeplink_actions.rs’sDeepLinkActionenum (snake_caseserde) and open them via Raycast’sopen()API, letting the desktop app parse and execute actions asynchronously.Confidence Score: 3/5
nullwhich disables mic/camera, and inline//comments violate the repository’s no-comments rule. Fixing these should make the change low-risk.Important Files Changed
Sequence Diagram
sequenceDiagram participant Raycast as Raycast Extension participant OS as OS URL Handler participant Cap as Cap Desktop (Tauri) participant DL as deeplink_actions.rs participant Rec as recording module Raycast->>Raycast: buildDeepLink(action, params) Raycast->>OS: open("cap-desktop://action?value=<encoded JSON>") OS->>Cap: Launch/activate app with URL Cap->>DL: handle(app_handle, urls) DL->>DL: TryFrom<Url> parse query `value` JSON DL->>DL: execute(action) alt start_recording DL->>Rec: set_camera_input / set_mic_input DL->>Rec: start_recording(inputs) else stop/pause/resume/toggle DL->>Rec: stop_recording / pause_recording / resume_recording / toggle_pause_recording else switch devices DL->>Rec: set_mic_input / set_camera_input else open settings/editor DL->>Cap: show_window(Settings) / open_project_from_path endContext used:
dashboard- CLAUDE.md (source)dashboard- AGENTS.md (source)