shortcutxl 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -0
- package/agent-docs/README.md +397 -0
- package/agent-docs/docs/compaction.md +390 -0
- package/agent-docs/docs/custom-provider.md +580 -0
- package/agent-docs/docs/development.md +69 -0
- package/agent-docs/docs/extensions.md +1971 -0
- package/agent-docs/docs/json.md +79 -0
- package/agent-docs/docs/keybindings.md +174 -0
- package/agent-docs/docs/models.md +293 -0
- package/agent-docs/docs/packages.md +209 -0
- package/agent-docs/docs/prompt-templates.md +67 -0
- package/agent-docs/docs/providers.md +186 -0
- package/agent-docs/docs/rpc.md +1317 -0
- package/agent-docs/docs/sdk.md +962 -0
- package/agent-docs/docs/session.md +412 -0
- package/agent-docs/docs/settings.md +223 -0
- package/agent-docs/docs/shell-aliases.md +13 -0
- package/agent-docs/docs/skills.md +231 -0
- package/agent-docs/docs/terminal-setup.md +70 -0
- package/agent-docs/docs/termux.md +127 -0
- package/agent-docs/docs/themes.md +295 -0
- package/agent-docs/docs/tree.md +219 -0
- package/agent-docs/docs/tui.md +887 -0
- package/agent-docs/docs/windows.md +17 -0
- package/agent-docs/examples/README.md +25 -0
- package/agent-docs/examples/extensions/README.md +205 -0
- package/agent-docs/examples/extensions/antigravity-image-gen.ts +447 -0
- package/agent-docs/examples/extensions/auto-commit-on-exit.ts +49 -0
- package/agent-docs/examples/extensions/bash-spawn-hook.ts +30 -0
- package/agent-docs/examples/extensions/bookmark.ts +50 -0
- package/agent-docs/examples/extensions/built-in-tool-renderer.ts +256 -0
- package/agent-docs/examples/extensions/claude-rules.ts +86 -0
- package/agent-docs/examples/extensions/commands.ts +75 -0
- package/agent-docs/examples/extensions/confirm-destructive.ts +59 -0
- package/agent-docs/examples/extensions/custom-compaction.ts +126 -0
- package/agent-docs/examples/extensions/custom-footer.ts +63 -0
- package/agent-docs/examples/extensions/custom-header.ts +73 -0
- package/agent-docs/examples/extensions/custom-provider-anthropic/index.ts +660 -0
- package/agent-docs/examples/extensions/custom-provider-anthropic/package-lock.json +24 -0
- package/agent-docs/examples/extensions/custom-provider-anthropic/package.json +19 -0
- package/agent-docs/examples/extensions/custom-provider-gitlab-duo/index.ts +362 -0
- package/agent-docs/examples/extensions/custom-provider-gitlab-duo/package.json +16 -0
- package/agent-docs/examples/extensions/custom-provider-gitlab-duo/test.ts +88 -0
- package/agent-docs/examples/extensions/custom-provider-qwen-cli/index.ts +349 -0
- package/agent-docs/examples/extensions/custom-provider-qwen-cli/package.json +16 -0
- package/agent-docs/examples/extensions/dirty-repo-guard.ts +56 -0
- package/agent-docs/examples/extensions/doom-overlay/README.md +46 -0
- package/agent-docs/examples/extensions/doom-overlay/doom/build.sh +152 -0
- package/agent-docs/examples/extensions/doom-overlay/doom/doomgeneric_pi.c +72 -0
- package/agent-docs/examples/extensions/doom-overlay/doom-component.ts +133 -0
- package/agent-docs/examples/extensions/doom-overlay/doom-engine.ts +186 -0
- package/agent-docs/examples/extensions/doom-overlay/doom-keys.ts +108 -0
- package/agent-docs/examples/extensions/doom-overlay/index.ts +74 -0
- package/agent-docs/examples/extensions/doom-overlay/wad-finder.ts +51 -0
- package/agent-docs/examples/extensions/dynamic-resources/SKILL.md +8 -0
- package/agent-docs/examples/extensions/dynamic-resources/dynamic.json +79 -0
- package/agent-docs/examples/extensions/dynamic-resources/dynamic.md +5 -0
- package/agent-docs/examples/extensions/dynamic-resources/index.ts +15 -0
- package/agent-docs/examples/extensions/dynamic-tools.ts +77 -0
- package/agent-docs/examples/extensions/event-bus.ts +43 -0
- package/agent-docs/examples/extensions/file-trigger.ts +41 -0
- package/agent-docs/examples/extensions/git-checkpoint.ts +53 -0
- package/agent-docs/examples/extensions/handoff.ts +155 -0
- package/agent-docs/examples/extensions/hello.ts +25 -0
- package/agent-docs/examples/extensions/inline-bash.ts +94 -0
- package/agent-docs/examples/extensions/input-transform.ts +43 -0
- package/agent-docs/examples/extensions/interactive-shell.ts +209 -0
- package/agent-docs/examples/extensions/mac-system-theme.ts +47 -0
- package/agent-docs/examples/extensions/message-renderer.ts +59 -0
- package/agent-docs/examples/extensions/minimal-mode.ts +430 -0
- package/agent-docs/examples/extensions/modal-editor.ts +90 -0
- package/agent-docs/examples/extensions/model-status.ts +31 -0
- package/agent-docs/examples/extensions/notify.ts +55 -0
- package/agent-docs/examples/extensions/overlay-qa-tests.ts +936 -0
- package/agent-docs/examples/extensions/overlay-test.ts +159 -0
- package/agent-docs/examples/extensions/permission-gate.ts +37 -0
- package/agent-docs/examples/extensions/pirate.ts +47 -0
- package/agent-docs/examples/extensions/plan-mode/README.md +65 -0
- package/agent-docs/examples/extensions/plan-mode/index.ts +363 -0
- package/agent-docs/examples/extensions/plan-mode/utils.ts +173 -0
- package/agent-docs/examples/extensions/preset.ts +418 -0
- package/agent-docs/examples/extensions/protected-paths.ts +30 -0
- package/agent-docs/examples/extensions/qna.ts +122 -0
- package/agent-docs/examples/extensions/question.ts +278 -0
- package/agent-docs/examples/extensions/questionnaire.ts +440 -0
- package/agent-docs/examples/extensions/rainbow-editor.ts +90 -0
- package/agent-docs/examples/extensions/reload-runtime.ts +37 -0
- package/agent-docs/examples/extensions/rpc-demo.ts +124 -0
- package/agent-docs/examples/extensions/sandbox/index.ts +324 -0
- package/agent-docs/examples/extensions/sandbox/package-lock.json +92 -0
- package/agent-docs/examples/extensions/sandbox/package.json +19 -0
- package/agent-docs/examples/extensions/send-user-message.ts +97 -0
- package/agent-docs/examples/extensions/session-name.ts +27 -0
- package/agent-docs/examples/extensions/shutdown-command.ts +69 -0
- package/agent-docs/examples/extensions/snake.ts +343 -0
- package/agent-docs/examples/extensions/space-invaders.ts +566 -0
- package/agent-docs/examples/extensions/ssh.ts +233 -0
- package/agent-docs/examples/extensions/status-line.ts +40 -0
- package/agent-docs/examples/extensions/subagent/README.md +172 -0
- package/agent-docs/examples/extensions/subagent/agents/planner.md +37 -0
- package/agent-docs/examples/extensions/subagent/agents/reviewer.md +35 -0
- package/agent-docs/examples/extensions/subagent/agents/scout.md +50 -0
- package/agent-docs/examples/extensions/subagent/agents/worker.md +24 -0
- package/agent-docs/examples/extensions/subagent/agents.ts +130 -0
- package/agent-docs/examples/extensions/subagent/index.ts +1068 -0
- package/agent-docs/examples/extensions/subagent/prompts/implement-and-review.md +10 -0
- package/agent-docs/examples/extensions/subagent/prompts/implement.md +10 -0
- package/agent-docs/examples/extensions/subagent/prompts/scout-and-plan.md +9 -0
- package/agent-docs/examples/extensions/summarize.ts +206 -0
- package/agent-docs/examples/extensions/system-prompt-header.ts +17 -0
- package/agent-docs/examples/extensions/timed-confirm.ts +72 -0
- package/agent-docs/examples/extensions/titlebar-spinner.ts +58 -0
- package/agent-docs/examples/extensions/todo.ts +314 -0
- package/agent-docs/examples/extensions/tool-override.ts +146 -0
- package/agent-docs/examples/extensions/tools.ts +145 -0
- package/agent-docs/examples/extensions/trigger-compact.ts +40 -0
- package/agent-docs/examples/extensions/truncated-tool.ts +194 -0
- package/agent-docs/examples/extensions/widget-placement.ts +17 -0
- package/agent-docs/examples/extensions/with-deps/index.ts +37 -0
- package/agent-docs/examples/extensions/with-deps/package-lock.json +31 -0
- package/agent-docs/examples/extensions/with-deps/package.json +22 -0
- package/agent-docs/examples/rpc-extension-ui.ts +654 -0
- package/agent-docs/examples/sdk/01-minimal.ts +22 -0
- package/agent-docs/examples/sdk/02-custom-model.ts +48 -0
- package/agent-docs/examples/sdk/03-custom-prompt.ts +55 -0
- package/agent-docs/examples/sdk/04-skills.ts +53 -0
- package/agent-docs/examples/sdk/05-tools.ts +56 -0
- package/agent-docs/examples/sdk/06-extensions.ts +88 -0
- package/agent-docs/examples/sdk/07-context-files.ts +40 -0
- package/agent-docs/examples/sdk/08-prompt-templates.ts +47 -0
- package/agent-docs/examples/sdk/09-api-keys-and-oauth.ts +48 -0
- package/agent-docs/examples/sdk/10-settings.ts +54 -0
- package/agent-docs/examples/sdk/11-sessions.ts +48 -0
- package/agent-docs/examples/sdk/12-full-control.ts +82 -0
- package/agent-docs/examples/sdk/README.md +144 -0
- package/agent-docs/xll-skill.md +61 -0
- package/agent-docs/xll-spec.md +110 -0
- package/dist/cli/args.js +290 -0
- package/dist/cli/config-selector.js +31 -0
- package/dist/cli/file-processor.js +79 -0
- package/dist/cli/list-models.js +92 -0
- package/dist/cli/package-commands.js +210 -0
- package/dist/cli/report-settings-errors.js +11 -0
- package/dist/cli/session-picker.js +34 -0
- package/dist/cli.js +19 -0
- package/dist/config.js +288 -0
- package/dist/core/abort.js +15 -0
- package/dist/core/agent-loop.js +352 -0
- package/dist/core/agent-session.js +2019 -0
- package/dist/core/agent.js +410 -0
- package/dist/core/auth-storage.js +456 -0
- package/dist/core/bash-executor.js +222 -0
- package/dist/core/compaction/branch-summarization.js +242 -0
- package/dist/core/compaction/compaction.js +610 -0
- package/dist/core/compaction/index.js +7 -0
- package/dist/core/compaction/utils.js +139 -0
- package/dist/core/defaults.js +6 -0
- package/dist/core/diagnostics.js +2 -0
- package/dist/core/event-bus.js +25 -0
- package/dist/core/exec.js +71 -0
- package/dist/core/export-html/ansi-to-html.js +256 -0
- package/dist/core/export-html/index.js +238 -0
- package/dist/core/export-html/session-view-model.js +342 -0
- package/dist/core/export-html/template.css +1110 -0
- package/dist/core/export-html/template.html +76 -0
- package/dist/core/export-html/template.js +1990 -0
- package/dist/core/export-html/tool-renderer.js +63 -0
- package/dist/core/export-html/vendor/highlight.min.js +7725 -0
- package/dist/core/export-html/vendor/marked.min.js +1803 -0
- package/dist/core/extensions/index.js +9 -0
- package/dist/core/extensions/loader.js +422 -0
- package/dist/core/extensions/runner.js +651 -0
- package/dist/core/extensions/types.js +35 -0
- package/dist/core/extensions/wrapper.js +102 -0
- package/dist/core/footer-data-provider.js +162 -0
- package/dist/core/index.js +9 -0
- package/dist/core/keybindings.js +153 -0
- package/dist/core/messages.js +133 -0
- package/dist/core/model-registry.js +539 -0
- package/dist/core/model-resolver.js +370 -0
- package/dist/core/package-manager.js +1485 -0
- package/dist/core/prompt-templates.js +253 -0
- package/dist/core/resolve-config-value.js +59 -0
- package/dist/core/resource-loader.js +700 -0
- package/dist/core/sdk.js +197 -0
- package/dist/core/session-bash.js +99 -0
- package/dist/core/session-compaction.js +165 -0
- package/dist/core/session-manager.js +1153 -0
- package/dist/core/session-models.js +99 -0
- package/dist/core/session-retry.js +155 -0
- package/dist/core/settings-manager.js +572 -0
- package/dist/core/skills.js +382 -0
- package/dist/core/slash-commands.js +31 -0
- package/dist/core/system-prompt.js +161 -0
- package/dist/core/theme.js +770 -0
- package/dist/core/timings.js +26 -0
- package/dist/core/tools/bash.js +258 -0
- package/dist/core/tools/edit-diff.js +245 -0
- package/dist/core/tools/edit.js +148 -0
- package/dist/core/tools/find.js +208 -0
- package/dist/core/tools/grep.js +246 -0
- package/dist/core/tools/index.js +67 -0
- package/dist/core/tools/ls.js +123 -0
- package/dist/core/tools/path-utils.js +81 -0
- package/dist/core/tools/read.js +160 -0
- package/dist/core/tools/truncate.js +70 -0
- package/dist/core/tools/write.js +82 -0
- package/dist/custom/agents/action.js +13 -0
- package/dist/custom/agents/document-reader.js +70 -0
- package/dist/custom/agents/general.js +26 -0
- package/dist/custom/agents/index.js +49 -0
- package/dist/custom/agents/installation.js +13 -0
- package/dist/custom/agents/types.js +7 -0
- package/dist/custom/auth/refresh-timer.js +33 -0
- package/dist/custom/auth/shortcut-oauth.js +145 -0
- package/dist/custom/constants.js +21 -0
- package/dist/custom/context/workbook-summary.js +73 -0
- package/dist/custom/credits/shortcut-credits.js +29 -0
- package/dist/custom/cron/cron-daemon-entry.js +18 -0
- package/dist/custom/cron/daemon-ipc.js +131 -0
- package/dist/custom/cron/daemon.js +224 -0
- package/dist/custom/cron/jobs.js +226 -0
- package/dist/custom/cron/run-log.js +51 -0
- package/dist/custom/cron/schedule.js +72 -0
- package/dist/custom/cron/status-line.js +98 -0
- package/dist/custom/cron/store.js +87 -0
- package/dist/custom/cron/types.js +8 -0
- package/dist/custom/dev/index.js +59 -0
- package/dist/custom/dev/trace-export.js +58 -0
- package/dist/custom/ensure-excel.js +63 -0
- package/dist/custom/excel-config.js +36 -0
- package/dist/custom/preflight.js +422 -0
- package/dist/custom/prompts/action.js +100 -0
- package/dist/custom/prompts/api.js +66 -0
- package/dist/custom/prompts/installation.js +124 -0
- package/dist/custom/prompts/shared.js +138 -0
- package/dist/custom/providers/llm-usage.js +42 -0
- package/dist/custom/providers/message-converter.js +74 -0
- package/dist/custom/providers/provider-ids.js +9 -0
- package/dist/custom/providers/register-openai-codex-provider.js +27 -0
- package/dist/custom/providers/register-shortcut-provider.js +52 -0
- package/dist/custom/providers/shortcut-invoke.js +117 -0
- package/dist/custom/providers/shortcut-stream.js +252 -0
- package/dist/custom/providers/sse-protocol.js +38 -0
- package/dist/custom/sync-xll.js +130 -0
- package/dist/custom/tools/cron.js +413 -0
- package/dist/custom/tools/excel-exec.js +167 -0
- package/dist/custom/tools/excel-range.js +50 -0
- package/dist/custom/tools/llm-analysis.js +265 -0
- package/dist/custom/tools/render-helpers.js +38 -0
- package/dist/custom/tools/switch-mode.js +94 -0
- package/dist/custom/tools/task/agents.js +6 -0
- package/dist/custom/tools/task/index.js +8 -0
- package/dist/custom/tools/task/render.js +348 -0
- package/dist/custom/tools/task/subprocess.js +320 -0
- package/dist/custom/tools/task/task.js +205 -0
- package/dist/custom/tools/todo-list.js +195 -0
- package/dist/custom/tracing/session-upload.js +93 -0
- package/dist/index.js +45 -0
- package/dist/main.js +613 -0
- package/dist/migrations.js +265 -0
- package/dist/modes/index.js +8 -0
- package/dist/modes/interactive/components/armin.js +337 -0
- package/dist/modes/interactive/components/assistant-message.js +94 -0
- package/dist/modes/interactive/components/bash-execution.js +171 -0
- package/dist/modes/interactive/components/bordered-loader.js +51 -0
- package/dist/modes/interactive/components/branch-summary-message.js +45 -0
- package/dist/modes/interactive/components/compaction-summary-message.js +46 -0
- package/dist/modes/interactive/components/config-selector.js +488 -0
- package/dist/modes/interactive/components/countdown-timer.js +33 -0
- package/dist/modes/interactive/components/custom-editor.js +93 -0
- package/dist/modes/interactive/components/custom-message.js +81 -0
- package/dist/modes/interactive/components/daxnuts.js +140 -0
- package/dist/modes/interactive/components/diff.js +133 -0
- package/dist/modes/interactive/components/dynamic-border.js +21 -0
- package/dist/modes/interactive/components/extension-editor.js +105 -0
- package/dist/modes/interactive/components/extension-input.js +61 -0
- package/dist/modes/interactive/components/extension-selector.js +78 -0
- package/dist/modes/interactive/components/footer.js +309 -0
- package/dist/modes/interactive/components/index.js +33 -0
- package/dist/modes/interactive/components/keybinding-hints.js +61 -0
- package/dist/modes/interactive/components/layout.js +64 -0
- package/dist/modes/interactive/components/login-dialog.js +148 -0
- package/dist/modes/interactive/components/model-selector.js +237 -0
- package/dist/modes/interactive/components/oauth-selector.js +111 -0
- package/dist/modes/interactive/components/session-selector-search.js +157 -0
- package/dist/modes/interactive/components/session-selector.js +860 -0
- package/dist/modes/interactive/components/settings-selector.js +123 -0
- package/dist/modes/interactive/components/show-images-selector.js +35 -0
- package/dist/modes/interactive/components/skill-invocation-message.js +48 -0
- package/dist/modes/interactive/components/theme-selector.js +47 -0
- package/dist/modes/interactive/components/thinking-selector.js +47 -0
- package/dist/modes/interactive/components/tool-execution.js +789 -0
- package/dist/modes/interactive/components/tool-group.js +106 -0
- package/dist/modes/interactive/components/tree-selector.js +962 -0
- package/dist/modes/interactive/components/user-message-selector.js +115 -0
- package/dist/modes/interactive/components/user-message.js +48 -0
- package/dist/modes/interactive/components/visual-truncate.js +33 -0
- package/dist/modes/interactive/file-attachments.js +135 -0
- package/dist/modes/interactive/interactive-mode.js +3775 -0
- package/dist/modes/interactive/theme/dark.json +85 -0
- package/dist/modes/interactive/theme/light.json +85 -0
- package/dist/modes/interactive/theme/theme-schema.json +335 -0
- package/dist/modes/interactive/theme/theme.js +177 -0
- package/dist/modes/print-mode.js +101 -0
- package/dist/modes/rpc/rpc-client.js +387 -0
- package/dist/modes/rpc/rpc-mode.js +509 -0
- package/dist/modes/rpc/rpc-types.js +8 -0
- package/dist/subagent-entry.js +145 -0
- package/dist/tool-names.js +34 -0
- package/dist/tui/autocomplete.js +596 -0
- package/dist/tui/components/box.js +104 -0
- package/dist/tui/components/cancellable-loader.js +35 -0
- package/dist/tui/components/editor.js +1679 -0
- package/dist/tui/components/image.js +69 -0
- package/dist/tui/components/input.js +433 -0
- package/dist/tui/components/loader.js +49 -0
- package/dist/tui/components/markdown.js +629 -0
- package/dist/tui/components/select-list.js +152 -0
- package/dist/tui/components/settings-list.js +185 -0
- package/dist/tui/components/spacer.js +23 -0
- package/dist/tui/components/text.js +89 -0
- package/dist/tui/components/truncated-text.js +51 -0
- package/dist/tui/editor-component.js +2 -0
- package/dist/tui/fuzzy.js +107 -0
- package/dist/tui/get-east-asian-width/index.js +32 -0
- package/dist/tui/get-east-asian-width/lookup.js +404 -0
- package/dist/tui/index.js +32 -0
- package/dist/tui/keybindings.js +114 -0
- package/dist/tui/keys.js +959 -0
- package/dist/tui/kill-ring.js +44 -0
- package/dist/tui/stdin-buffer.js +317 -0
- package/dist/tui/terminal-image.js +288 -0
- package/dist/tui/terminal.js +249 -0
- package/dist/tui/tui/autocomplete.js +596 -0
- package/dist/tui/tui/components/box.js +106 -0
- package/dist/tui/tui/components/cancellable-loader.js +35 -0
- package/dist/tui/tui/components/editor.js +1679 -0
- package/dist/tui/tui/components/image.js +69 -0
- package/dist/tui/tui/components/input.js +433 -0
- package/dist/tui/tui/components/loader.js +49 -0
- package/dist/tui/tui/components/markdown.js +629 -0
- package/dist/tui/tui/components/select-list.js +152 -0
- package/dist/tui/tui/components/settings-list.js +185 -0
- package/dist/tui/tui/components/spacer.js +23 -0
- package/dist/tui/tui/components/text.js +91 -0
- package/dist/tui/tui/components/truncated-text.js +51 -0
- package/dist/tui/tui/editor-component.js +2 -0
- package/dist/tui/tui/fuzzy.js +107 -0
- package/dist/tui/tui/get-east-asian-width/index.js +32 -0
- package/dist/tui/tui/get-east-asian-width/lookup.js +404 -0
- package/dist/tui/tui/index.js +32 -0
- package/dist/tui/tui/keybindings.js +114 -0
- package/dist/tui/tui/keys.js +959 -0
- package/dist/tui/tui/kill-ring.js +44 -0
- package/dist/tui/tui/stdin-buffer.js +317 -0
- package/dist/tui/tui/terminal-image.js +288 -0
- package/dist/tui/tui/terminal.js +249 -0
- package/dist/tui/tui/tui.js +955 -0
- package/dist/tui/tui/undo-stack.js +25 -0
- package/dist/tui/tui/utils.js +800 -0
- package/dist/tui/tui.js +955 -0
- package/dist/tui/undo-stack.js +25 -0
- package/dist/tui/utils.js +800 -0
- package/dist/utils/changelog.js +87 -0
- package/dist/utils/clipboard-image.js +164 -0
- package/dist/utils/clipboard-native.js +14 -0
- package/dist/utils/clipboard.js +67 -0
- package/dist/utils/frontmatter.js +26 -0
- package/dist/utils/git.js +166 -0
- package/dist/utils/image-convert.js +35 -0
- package/dist/utils/image-resize.js +183 -0
- package/dist/utils/mime.js +26 -0
- package/dist/utils/photon.js +121 -0
- package/dist/utils/shell.js +217 -0
- package/dist/utils/sleep.js +17 -0
- package/dist/utils/tools-manager.js +259 -0
- package/package.json +78 -0
- package/skills/excel-com-api/SKILL.md +74 -0
- package/skills/excel-com-api/excel-type-library.py +27767 -0
- package/skills/excel-com-api/office-type-library.py +10867 -0
- package/skills/integrations/SKILL.md +138 -0
- package/skills/integrations/alphasense.md +457 -0
- package/skills/integrations/bloomberg.md +803 -0
- package/skills/integrations/calcbench.md +315 -0
- package/skills/integrations/capiq.md +848 -0
- package/skills/integrations/dynamics-365-finance.md +354 -0
- package/skills/integrations/earnings_transcripts.md +387 -0
- package/skills/integrations/factset.md +758 -0
- package/skills/integrations/ice-fixed-income.md +344 -0
- package/skills/integrations/moodys-analytics.md +313 -0
- package/skills/integrations/morningstar.md +433 -0
- package/skills/integrations/nasdaq-data-link.md +249 -0
- package/skills/integrations/pitchbook.md +413 -0
- package/skills/integrations/preqin.md +422 -0
- package/skills/integrations/quickbooks.md +289 -0
- package/skills/integrations/quickfs.md +314 -0
- package/skills/integrations/refinitiv.md +473 -0
- package/skills/integrations/sage-intacct.md +401 -0
- package/skills/integrations/visible-alpha.md +320 -0
- package/skills/integrations/xero.md +393 -0
- package/skills/integrations/ycharts.md +306 -0
- package/skills/pdf-creation/SKILL.md +93 -0
- package/skills/pdf-extraction/SKILL.md +32 -0
- package/skills/powerpoint-creation/SKILL.md +110 -0
- package/skills/sec-edgar/SKILL.md +127 -0
- package/skills/sec-edgar/sec_to_pdf.py +109 -0
- package/xll/ShortcutXL.xll +0 -0
- package/xll/modules/debug_render.py +272 -0
- package/xll/modules/gameboy.py +241 -0
- package/xll/modules/pong.py +188 -0
- package/xll/modules/shortcut_xl/__init__.py +18 -0
- package/xll/modules/shortcut_xl/_categorize.py +200 -0
- package/xll/modules/shortcut_xl/_com.py +108 -0
- package/xll/modules/shortcut_xl/_format.py +252 -0
- package/xll/modules/shortcut_xl/_log.py +12 -0
- package/xll/modules/shortcut_xl/_managed.py +116 -0
- package/xll/modules/shortcut_xl/_registry.py +44 -0
- package/xll/modules/shortcut_xl/_threading.py +161 -0
- package/xll/modules/shortcut_xl/_tracking.py +283 -0
- package/xll/modules/stocks.py +100 -0
- package/xll/python3.dll +0 -0
- package/xll/python312.dll +0 -0
|
@@ -0,0 +1,422 @@
|
|
|
1
|
+
**Preqin Excel Add-In Guide**
|
|
2
|
+
|
|
3
|
+
**Intro**
|
|
4
|
+
You have full access to Preqin through the Excel Add-In ("Preqin for Excel"), but you should only pull Preqin data **when the user explicitly tells you to**. Preqin provides comprehensive alternative assets data including private equity, venture capital, real estate, infrastructure, private debt, natural resources, and hedge funds. You can retrieve fund performance, fundraising, deals, investors, and benchmarks through the Excel integration.
|
|
5
|
+
|
|
6
|
+
**IMPORTANT:** Before completing a task involving Preqin, you must verify:
|
|
7
|
+
1. Your Preqin formulas/queries do not return errors.
|
|
8
|
+
2. All values should seem reasonable and make intuitive sense based on your knowledge of private markets.
|
|
9
|
+
3. Use cell references for identifiers when possible as opposed to hardcoded values.
|
|
10
|
+
|
|
11
|
+
You should essentially gut check every value that shows up. If there are any errors or the values seem wrong, you likely configured the query incorrectly. Please correct until it outputs the proper value.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
**Preqin Data Coverage**
|
|
16
|
+
|
|
17
|
+
Preqin provides data across alternative asset classes:
|
|
18
|
+
|
|
19
|
+
| Asset Class | Coverage |
|
|
20
|
+
|-------------|----------|
|
|
21
|
+
| Private Equity | Buyout, Growth, Turnaround |
|
|
22
|
+
| Venture Capital | Early Stage, Late Stage, Seed |
|
|
23
|
+
| Real Estate | Core, Value-Add, Opportunistic |
|
|
24
|
+
| Infrastructure | Energy, Transport, Utilities |
|
|
25
|
+
| Private Debt | Direct Lending, Mezzanine, Distressed |
|
|
26
|
+
| Natural Resources | Energy, Mining, Timber, Agriculture |
|
|
27
|
+
| Hedge Funds | Various strategies |
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
**1. Data Categories**
|
|
32
|
+
|
|
33
|
+
**Funds:**
|
|
34
|
+
Fund profiles, performance, cash flows, benchmarks
|
|
35
|
+
|
|
36
|
+
**Fundraising:**
|
|
37
|
+
Funds in market, fund closings, capital raised
|
|
38
|
+
|
|
39
|
+
**Deals:**
|
|
40
|
+
Buyout, VC, real estate, infrastructure transactions
|
|
41
|
+
|
|
42
|
+
**Investors:**
|
|
43
|
+
LPs, allocations, commitments, preferences
|
|
44
|
+
|
|
45
|
+
**Fund Managers:**
|
|
46
|
+
GP profiles, track records, AUM
|
|
47
|
+
|
|
48
|
+
**Benchmarks:**
|
|
49
|
+
Vintage year, strategy, geography benchmarks
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
**2. Fund Performance Metrics**
|
|
54
|
+
|
|
55
|
+
**Return Metrics:**
|
|
56
|
+
| Metric | Description |
|
|
57
|
+
|--------|-------------|
|
|
58
|
+
| Net IRR | Net internal rate of return to LPs |
|
|
59
|
+
| Gross IRR | Gross IRR before fees |
|
|
60
|
+
| Net IRR Since Inception | IRR from fund inception |
|
|
61
|
+
| PME | Public market equivalent |
|
|
62
|
+
| Direct Alpha | Alpha vs public market |
|
|
63
|
+
| KS-PME | Kaplan-Schoar PME |
|
|
64
|
+
|
|
65
|
+
**Multiple Metrics:**
|
|
66
|
+
| Metric | Description |
|
|
67
|
+
|--------|-------------|
|
|
68
|
+
| TVPI | Total Value to Paid-In (investment multiple) |
|
|
69
|
+
| DPI | Distributions to Paid-In (realized multiple) |
|
|
70
|
+
| RVPI | Residual Value to Paid-In (unrealized multiple) |
|
|
71
|
+
| Gross Multiple | Gross investment multiple |
|
|
72
|
+
| Net Multiple | Net multiple to LPs |
|
|
73
|
+
|
|
74
|
+
**Quartile Rankings:**
|
|
75
|
+
| Metric | Description |
|
|
76
|
+
|--------|-------------|
|
|
77
|
+
| IRR Quartile | 1st, 2nd, 3rd, 4th quartile |
|
|
78
|
+
| Multiple Quartile | TVPI quartile ranking |
|
|
79
|
+
| Quartile Rank | Percentile ranking |
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
**3. Fund Profile Data**
|
|
84
|
+
|
|
85
|
+
**Fund Identification:**
|
|
86
|
+
| Field | Description |
|
|
87
|
+
|-------|-------------|
|
|
88
|
+
| FundID | Preqin fund identifier |
|
|
89
|
+
| FundName | Legal fund name |
|
|
90
|
+
| FirmName | GP/manager name |
|
|
91
|
+
| FirmID | Preqin firm identifier |
|
|
92
|
+
| Vintage | Vintage year |
|
|
93
|
+
| FundStatus | Open, Closed, Liquidated |
|
|
94
|
+
| Currency | Fund currency |
|
|
95
|
+
|
|
96
|
+
**Fund Characteristics:**
|
|
97
|
+
| Field | Description |
|
|
98
|
+
|-------|-------------|
|
|
99
|
+
| FundSize | Target/final fund size |
|
|
100
|
+
| FundSizeUSD | Fund size in USD |
|
|
101
|
+
| Strategy | Investment strategy |
|
|
102
|
+
| SubStrategy | Sub-strategy |
|
|
103
|
+
| Geography | Target geography |
|
|
104
|
+
| GeographicFocus | Regional focus |
|
|
105
|
+
| Industry | Industry focus |
|
|
106
|
+
| FundType | Primary, Secondary, Fund of Funds |
|
|
107
|
+
| FundStructure | Limited Partnership, etc. |
|
|
108
|
+
|
|
109
|
+
**Fund Timeline:**
|
|
110
|
+
| Field | Description |
|
|
111
|
+
|-------|-------------|
|
|
112
|
+
| FirstClose | First close date |
|
|
113
|
+
| FinalClose | Final close date |
|
|
114
|
+
| InvestmentPeriod | Investment period (years) |
|
|
115
|
+
| FundTerm | Fund term (years) |
|
|
116
|
+
| ExtensionOptions | Extension provisions |
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
**4. Cash Flow Data**
|
|
121
|
+
|
|
122
|
+
Preqin provides fund-level cash flow transactions:
|
|
123
|
+
|
|
124
|
+
**Cash Flow Types:**
|
|
125
|
+
| Type | Description |
|
|
126
|
+
|------|-------------|
|
|
127
|
+
| Capital Call | Contributions from LPs |
|
|
128
|
+
| Distribution | Cash distributed to LPs |
|
|
129
|
+
| Valuation | NAV/residual value |
|
|
130
|
+
| Recallable | Recallable distributions |
|
|
131
|
+
|
|
132
|
+
**Cash Flow Fields:**
|
|
133
|
+
| Field | Description |
|
|
134
|
+
|-------|-------------|
|
|
135
|
+
| TransactionDate | Date of cash flow |
|
|
136
|
+
| TransactionType | Call, Distribution, Valuation |
|
|
137
|
+
| Amount | Transaction amount |
|
|
138
|
+
| AmountUSD | Amount in USD |
|
|
139
|
+
| CumulativeContributions | Total contributions to date |
|
|
140
|
+
| CumulativeDistributions | Total distributions to date |
|
|
141
|
+
| NAV | Net asset value |
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
**5. Fundraising Data**
|
|
146
|
+
|
|
147
|
+
**Funds in Market:**
|
|
148
|
+
| Field | Description |
|
|
149
|
+
|-------|-------------|
|
|
150
|
+
| FundName | Fund name |
|
|
151
|
+
| TargetSize | Target fundraise |
|
|
152
|
+
| CurrentSize | Amount raised to date |
|
|
153
|
+
| LaunchDate | Fund launch date |
|
|
154
|
+
| ExpectedClose | Expected final close |
|
|
155
|
+
| FundrasingStatus | In Market, Closed, etc. |
|
|
156
|
+
|
|
157
|
+
**Capital Raised:**
|
|
158
|
+
| Field | Description |
|
|
159
|
+
|-------|-------------|
|
|
160
|
+
| QuarterlyCapitalRaised | Capital raised by quarter |
|
|
161
|
+
| AnnualCapitalRaised | Capital raised by year |
|
|
162
|
+
| NumberOfFundsClosed | Count of fund closings |
|
|
163
|
+
| AverageSize | Average fund size |
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
**6. Deal/Transaction Data**
|
|
168
|
+
|
|
169
|
+
**Deal Profile:**
|
|
170
|
+
| Field | Description |
|
|
171
|
+
|-------|-------------|
|
|
172
|
+
| DealID | Preqin deal identifier |
|
|
173
|
+
| CompanyName | Portfolio company |
|
|
174
|
+
| DealDate | Transaction date |
|
|
175
|
+
| DealType | Buyout, Growth, VC, Add-on |
|
|
176
|
+
| DealStatus | Completed, Pending, Exited |
|
|
177
|
+
|
|
178
|
+
**Deal Financials:**
|
|
179
|
+
| Field | Description |
|
|
180
|
+
|-------|-------------|
|
|
181
|
+
| DealSize | Transaction value |
|
|
182
|
+
| EnterpriseValue | EV at entry |
|
|
183
|
+
| EquityValue | Equity investment |
|
|
184
|
+
| DebtAmount | Debt financing |
|
|
185
|
+
| EVRevenue | EV/Revenue multiple |
|
|
186
|
+
| EVEBITDA | EV/EBITDA multiple |
|
|
187
|
+
|
|
188
|
+
**Exit Data:**
|
|
189
|
+
| Field | Description |
|
|
190
|
+
|-------|-------------|
|
|
191
|
+
| ExitDate | Exit date |
|
|
192
|
+
| ExitType | Trade Sale, IPO, Secondary |
|
|
193
|
+
| ExitValue | Exit enterprise value |
|
|
194
|
+
| MOIC | Multiple on invested capital |
|
|
195
|
+
| ExitIRR | IRR at exit |
|
|
196
|
+
| HoldingPeriod | Years held |
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
**7. Investor (LP) Data**
|
|
201
|
+
|
|
202
|
+
**Investor Profile:**
|
|
203
|
+
| Field | Description |
|
|
204
|
+
|-------|-------------|
|
|
205
|
+
| InvestorID | Preqin investor identifier |
|
|
206
|
+
| InvestorName | LP name |
|
|
207
|
+
| InvestorType | Pension, Endowment, etc. |
|
|
208
|
+
| Location | Headquarters location |
|
|
209
|
+
| AUM | Total assets under management |
|
|
210
|
+
| AlternativesAUM | Alternatives allocation |
|
|
211
|
+
|
|
212
|
+
**Investor Types:**
|
|
213
|
+
| Type | Description |
|
|
214
|
+
|------|-------------|
|
|
215
|
+
| Public Pension | State/local pensions |
|
|
216
|
+
| Corporate Pension | Corporate pension plans |
|
|
217
|
+
| Endowment | University endowments |
|
|
218
|
+
| Foundation | Private foundations |
|
|
219
|
+
| Sovereign Wealth | SWFs |
|
|
220
|
+
| Insurance | Insurance companies |
|
|
221
|
+
| Family Office | Family offices |
|
|
222
|
+
| Fund of Funds | Fund of funds managers |
|
|
223
|
+
| Asset Manager | Asset management firms |
|
|
224
|
+
|
|
225
|
+
**Allocation Data:**
|
|
226
|
+
| Field | Description |
|
|
227
|
+
|-------|-------------|
|
|
228
|
+
| CurrentAllocation | Current % to alternatives |
|
|
229
|
+
| TargetAllocation | Target % to alternatives |
|
|
230
|
+
| AllocationByStrategy | Breakdown by PE, VC, RE, etc. |
|
|
231
|
+
| CommitmentsPastYear | Commitments in past 12M |
|
|
232
|
+
| AverageCommitmentSize | Average commitment |
|
|
233
|
+
|
|
234
|
+
**Investment Preferences:**
|
|
235
|
+
| Field | Description |
|
|
236
|
+
|-------|-------------|
|
|
237
|
+
| PreferredStrategies | Target strategies |
|
|
238
|
+
| PreferredGeographies | Target regions |
|
|
239
|
+
| PreferredFundSizes | Fund size preferences |
|
|
240
|
+
| PreferredVintages | Vintage preferences |
|
|
241
|
+
| DirectInvesting | Direct/co-invest interest |
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
**8. Fund Manager (GP) Data**
|
|
246
|
+
|
|
247
|
+
**Manager Profile:**
|
|
248
|
+
| Field | Description |
|
|
249
|
+
|-------|-------------|
|
|
250
|
+
| FirmID | Preqin firm identifier |
|
|
251
|
+
| FirmName | GP name |
|
|
252
|
+
| Headquarters | HQ location |
|
|
253
|
+
| YearFounded | Year established |
|
|
254
|
+
| AUM | Assets under management |
|
|
255
|
+
| DryPowder | Uninvested capital |
|
|
256
|
+
|
|
257
|
+
**Track Record:**
|
|
258
|
+
| Field | Description |
|
|
259
|
+
|-------|-------------|
|
|
260
|
+
| NumberOfFunds | Total funds managed |
|
|
261
|
+
| TotalCapitalRaised | Lifetime capital raised |
|
|
262
|
+
| AverageIRR | Average net IRR |
|
|
263
|
+
| AverageMultiple | Average TVPI |
|
|
264
|
+
| TopQuartileFunds | % funds in top quartile |
|
|
265
|
+
|
|
266
|
+
---
|
|
267
|
+
|
|
268
|
+
**9. Benchmark Data**
|
|
269
|
+
|
|
270
|
+
**Benchmark Types:**
|
|
271
|
+
| Type | Description |
|
|
272
|
+
|------|-------------|
|
|
273
|
+
| Vintage Year | By fund vintage year |
|
|
274
|
+
| Strategy | By investment strategy |
|
|
275
|
+
| Geography | By target region |
|
|
276
|
+
| Size | By fund size bucket |
|
|
277
|
+
|
|
278
|
+
**Benchmark Metrics:**
|
|
279
|
+
| Metric | Description |
|
|
280
|
+
|--------|-------------|
|
|
281
|
+
| MedianIRR | Median net IRR |
|
|
282
|
+
| MedianTVPI | Median TVPI |
|
|
283
|
+
| UpperQuartileIRR | 75th percentile IRR |
|
|
284
|
+
| LowerQuartileIRR | 25th percentile IRR |
|
|
285
|
+
| TopDecileIRR | 90th percentile IRR |
|
|
286
|
+
| PMEMedian | Median PME vs S&P 500 |
|
|
287
|
+
|
|
288
|
+
**Custom Benchmarks:**
|
|
289
|
+
Preqin Pro allows creation of custom benchmarks based on:
|
|
290
|
+
- Strategy combinations
|
|
291
|
+
- Geographic filters
|
|
292
|
+
- Size ranges
|
|
293
|
+
- Vintage year ranges
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
**10. Strategies**
|
|
298
|
+
|
|
299
|
+
**Private Equity:**
|
|
300
|
+
| Strategy | Description |
|
|
301
|
+
|----------|-------------|
|
|
302
|
+
| Buyout | Leveraged buyouts |
|
|
303
|
+
| Growth | Growth equity |
|
|
304
|
+
| Turnaround | Distressed/turnaround |
|
|
305
|
+
| Secondaries | Secondary transactions |
|
|
306
|
+
| Co-Investment | Direct co-investments |
|
|
307
|
+
| Fund of Funds | PE fund of funds |
|
|
308
|
+
|
|
309
|
+
**Venture Capital:**
|
|
310
|
+
| Strategy | Description |
|
|
311
|
+
|----------|-------------|
|
|
312
|
+
| Seed | Seed stage |
|
|
313
|
+
| Early Stage | Series A/B |
|
|
314
|
+
| Late Stage | Series C+ |
|
|
315
|
+
| Balanced | Multi-stage |
|
|
316
|
+
|
|
317
|
+
**Private Debt:**
|
|
318
|
+
| Strategy | Description |
|
|
319
|
+
|----------|-------------|
|
|
320
|
+
| Direct Lending | Senior debt |
|
|
321
|
+
| Mezzanine | Junior debt |
|
|
322
|
+
| Distressed Debt | Distressed opportunities |
|
|
323
|
+
| Special Situations | Special situations |
|
|
324
|
+
| Venture Debt | Venture lending |
|
|
325
|
+
|
|
326
|
+
**Real Estate:**
|
|
327
|
+
| Strategy | Description |
|
|
328
|
+
|----------|-------------|
|
|
329
|
+
| Core | Core/stable assets |
|
|
330
|
+
| Core-Plus | Core-plus |
|
|
331
|
+
| Value Add | Value-add |
|
|
332
|
+
| Opportunistic | Opportunistic |
|
|
333
|
+
| Debt | Real estate debt |
|
|
334
|
+
|
|
335
|
+
**Infrastructure:**
|
|
336
|
+
| Strategy | Description |
|
|
337
|
+
|----------|-------------|
|
|
338
|
+
| Brownfield | Existing assets |
|
|
339
|
+
| Greenfield | Development |
|
|
340
|
+
| Core | Core infrastructure |
|
|
341
|
+
| Core-Plus | Core-plus infra |
|
|
342
|
+
| Value Add | Value-add infra |
|
|
343
|
+
|
|
344
|
+
---
|
|
345
|
+
|
|
346
|
+
**11. Using Preqin for Excel**
|
|
347
|
+
|
|
348
|
+
**Data Retrieval Methods:**
|
|
349
|
+
|
|
350
|
+
1. **Query Builder:**
|
|
351
|
+
- Access via Preqin tab in Excel
|
|
352
|
+
- Select data category (Funds, Deals, Investors, etc.)
|
|
353
|
+
- Apply filters (strategy, geography, vintage, etc.)
|
|
354
|
+
- Select fields to retrieve
|
|
355
|
+
- Insert data into spreadsheet
|
|
356
|
+
|
|
357
|
+
2. **Saved Searches:**
|
|
358
|
+
- Create and save searches in Preqin Pro web
|
|
359
|
+
- Pull saved searches into Excel
|
|
360
|
+
- Refresh data with one click
|
|
361
|
+
|
|
362
|
+
3. **Data Export:**
|
|
363
|
+
- Export datasets from Preqin Pro
|
|
364
|
+
- Import into Excel for analysis
|
|
365
|
+
|
|
366
|
+
**Common Workflows:**
|
|
367
|
+
- Pull benchmark data for fund comparison
|
|
368
|
+
- Retrieve LP commitments for fundraising targeting
|
|
369
|
+
- Export deal comps for valuation analysis
|
|
370
|
+
- Download cash flows for portfolio modeling
|
|
371
|
+
|
|
372
|
+
---
|
|
373
|
+
|
|
374
|
+
**12. Example Queries**
|
|
375
|
+
|
|
376
|
+
**Fund Performance:**
|
|
377
|
+
- All PE buyout funds vintage 2015-2020
|
|
378
|
+
- Funds with IRR > 15% and TVPI > 1.5x
|
|
379
|
+
- Top quartile funds by geography
|
|
380
|
+
|
|
381
|
+
**Fundraising:**
|
|
382
|
+
- Funds currently in market by strategy
|
|
383
|
+
- Capital raised by quarter/year
|
|
384
|
+
- Average fund sizes by vintage
|
|
385
|
+
|
|
386
|
+
**Deals:**
|
|
387
|
+
- Recent buyout transactions > $500M
|
|
388
|
+
- Add-on acquisitions by platform company
|
|
389
|
+
- Exit transactions with MOIC > 2x
|
|
390
|
+
|
|
391
|
+
**Investors:**
|
|
392
|
+
- Public pensions with > $1B in PE
|
|
393
|
+
- LPs that committed to funds in 2023
|
|
394
|
+
- Investors by strategy preference
|
|
395
|
+
|
|
396
|
+
---
|
|
397
|
+
|
|
398
|
+
**13. Data Export Limits**
|
|
399
|
+
|
|
400
|
+
Preqin may have export limits based on subscription tier:
|
|
401
|
+
- Check with your Preqin representative for specific limits
|
|
402
|
+
- Use saved searches to organize large data pulls
|
|
403
|
+
- Export in batches if necessary
|
|
404
|
+
|
|
405
|
+
---
|
|
406
|
+
|
|
407
|
+
**Final Checklist:**
|
|
408
|
+
- What data category am I querying? (Funds, Deals, Investors, GPs?)
|
|
409
|
+
- What filters do I need? (Strategy, geography, vintage, size?)
|
|
410
|
+
- What specific fields do I want to retrieve?
|
|
411
|
+
- Is this for benchmarking, targeting, or analysis?
|
|
412
|
+
- Have I verified the data using Preqin Pro web first?
|
|
413
|
+
- Am I within data export limits?
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
**Additional Resources:**
|
|
418
|
+
- Preqin Pro: preqin.com/our-products/preqin-pro
|
|
419
|
+
- Preqin for Excel: preqin.com/our-products/preqin-for-excel
|
|
420
|
+
- Help Center: preqin.com/help-center
|
|
421
|
+
- Data Guides: docs.preqin.com
|
|
422
|
+
- Academy: preqin.com/academy
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
**QuickBooks Excel Formula Guide**
|
|
2
|
+
|
|
3
|
+
**Intro**
|
|
4
|
+
You have full access to QuickBooks data through the CData Excel Add-in for QuickBooks, but you should only pull QuickBooks data **when the user explicitly tells you to**. The CData connector enables SQL-style queries against QuickBooks tables including invoices, bills, customers, vendors, accounts, and journal entries. You can retrieve any data point by writing CDATAQUERY formulas directly in Excel cells.
|
|
5
|
+
|
|
6
|
+
**IMPORTANT:** Before completing a task involving QuickBooks, you must verify:
|
|
7
|
+
1. Your CDATAQUERY formulas do not return errors.
|
|
8
|
+
2. All values should seem reasonable and make intuitive sense based on your general knowledge of accounting.
|
|
9
|
+
3. Use cell references for dynamic values when possible as opposed to hardcoded values.
|
|
10
|
+
4. Be aware that QuickBooks data refreshes require an active connection to the QuickBooks company file.
|
|
11
|
+
5. Date formats in queries should use ISO format (YYYY-MM-DD) or QuickBooks date literals.
|
|
12
|
+
|
|
13
|
+
You should essentially gut check every value that shows up. If there are any errors or the values seem wrong, you likely wrote the SQL syntax incorrectly or are referencing invalid table/field names. Please correct the formula until it outputs the proper value.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
**CData Excel Functions Overview**
|
|
18
|
+
|
|
19
|
+
CData provides one main Excel function for QuickBooks:
|
|
20
|
+
|
|
21
|
+
| Function | Purpose | Use Case |
|
|
22
|
+
|----------|---------|----------|
|
|
23
|
+
| CDATAQUERY | Execute SQL query | Retrieve any QuickBooks data via SQL SELECT statements |
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
**1. CDATAQUERY - SQL Query Function**
|
|
28
|
+
|
|
29
|
+
Returns data from QuickBooks using SQL syntax. Results spill into adjacent cells.
|
|
30
|
+
|
|
31
|
+
**Syntax:** =CDATAQUERY("SQL Query")
|
|
32
|
+
|
|
33
|
+
**Basic Examples:**
|
|
34
|
+
=CDATAQUERY("SELECT * FROM Invoices LIMIT 10")
|
|
35
|
+
-> First 10 invoices with all fields.
|
|
36
|
+
|
|
37
|
+
=CDATAQUERY("SELECT CustomerName, Balance FROM Customers WHERE Balance > 0")
|
|
38
|
+
-> Customers with outstanding balances.
|
|
39
|
+
|
|
40
|
+
=CDATAQUERY("SELECT * FROM Accounts WHERE AccountType = 'Income'")
|
|
41
|
+
-> All income accounts from chart of accounts.
|
|
42
|
+
|
|
43
|
+
**Using Cell References:**
|
|
44
|
+
=CDATAQUERY("SELECT * FROM Invoices WHERE CustomerName = '" & A1 & "'")
|
|
45
|
+
-> Invoices for customer name in cell A1.
|
|
46
|
+
|
|
47
|
+
=CDATAQUERY("SELECT * FROM Bills WHERE TotalAmt > " & B1)
|
|
48
|
+
-> Bills exceeding amount in cell B1.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
**2. Connection Setup**
|
|
53
|
+
|
|
54
|
+
Before using CDATAQUERY, the CData Excel Add-in must be configured:
|
|
55
|
+
|
|
56
|
+
1. Install CData Excel Add-in for QuickBooks (~$500-1000/year license)
|
|
57
|
+
2. Open Excel and go to CData ribbon tab
|
|
58
|
+
3. Click "Get Data" or "Connect"
|
|
59
|
+
4. Select QuickBooks as data source
|
|
60
|
+
5. Authenticate with QuickBooks Online credentials or connect to Desktop company file
|
|
61
|
+
6. Connection persists for session; re-authenticate if connection drops
|
|
62
|
+
|
|
63
|
+
**Connection Types:**
|
|
64
|
+
| Type | Description |
|
|
65
|
+
|------|-------------|
|
|
66
|
+
| QuickBooks Online | OAuth2 authentication to cloud instance |
|
|
67
|
+
| QuickBooks Desktop | Local connection to .QBW company file |
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
**3. QuickBooks Tables Reference**
|
|
72
|
+
|
|
73
|
+
**Core Transaction Tables:**
|
|
74
|
+
| Table | Description | Key Fields |
|
|
75
|
+
|-------|-------------|------------|
|
|
76
|
+
| Invoices | Customer invoices | Id, CustomerName, TxnDate, DueDate, TotalAmt, Balance |
|
|
77
|
+
| Bills | Vendor bills | Id, VendorName, TxnDate, DueDate, TotalAmt, Balance |
|
|
78
|
+
| Payments | Customer payments received | Id, CustomerName, TxnDate, TotalAmt, UnappliedAmt |
|
|
79
|
+
| BillPayments | Payments to vendors | Id, VendorName, TxnDate, TotalAmt |
|
|
80
|
+
| Credits | Credit memos | Id, CustomerName, TxnDate, TotalAmt, RemainingCredit |
|
|
81
|
+
| Deposits | Bank deposits | Id, TxnDate, TotalAmt, AccountName |
|
|
82
|
+
| Purchases | Purchase transactions | Id, VendorName, TxnDate, TotalAmt, AccountName |
|
|
83
|
+
| SalesReceipts | Cash sales | Id, CustomerName, TxnDate, TotalAmt |
|
|
84
|
+
| JournalEntries | General ledger entries | Id, TxnDate, TotalAmt, Adjustment |
|
|
85
|
+
|
|
86
|
+
**Master Data Tables:**
|
|
87
|
+
| Table | Description | Key Fields |
|
|
88
|
+
|-------|-------------|------------|
|
|
89
|
+
| Customers | Customer master list | Id, DisplayName, CompanyName, Balance, Email, Phone |
|
|
90
|
+
| Vendors | Vendor master list | Id, DisplayName, CompanyName, Balance, Email, Phone |
|
|
91
|
+
| Accounts | Chart of accounts | Id, Name, AccountType, AccountSubType, CurrentBalance |
|
|
92
|
+
| Items | Products and services | Id, Name, Type, UnitPrice, QtyOnHand, Description |
|
|
93
|
+
| Employees | Employee records | Id, DisplayName, Email, Phone, HiredDate |
|
|
94
|
+
| Classes | Class tracking | Id, Name, FullyQualifiedName |
|
|
95
|
+
| Departments | Department/location tracking | Id, Name, FullyQualifiedName |
|
|
96
|
+
|
|
97
|
+
**Report Tables:**
|
|
98
|
+
| Table | Description | Key Fields |
|
|
99
|
+
|-------|-------------|------------|
|
|
100
|
+
| ProfitAndLoss | P&L report data | Account, Amount, AccountType |
|
|
101
|
+
| BalanceSheet | Balance sheet data | Account, Amount, AccountType |
|
|
102
|
+
| BalanceSheetDetail | Detailed balance sheet | Account, Amount, Date, TransactionType |
|
|
103
|
+
| GeneralLedger | GL transaction detail | Account, Date, Amount, TransactionType, Name |
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
**4. Common Field Reference**
|
|
108
|
+
|
|
109
|
+
**Invoice Fields:**
|
|
110
|
+
| Field | Description |
|
|
111
|
+
|-------|-------------|
|
|
112
|
+
| Id | Unique invoice identifier |
|
|
113
|
+
| DocNumber | Invoice number |
|
|
114
|
+
| CustomerName | Customer display name |
|
|
115
|
+
| CustomerEmail | Customer email address |
|
|
116
|
+
| TxnDate | Transaction date |
|
|
117
|
+
| DueDate | Payment due date |
|
|
118
|
+
| TotalAmt | Invoice total |
|
|
119
|
+
| Balance | Remaining balance |
|
|
120
|
+
| ShipDate | Shipping date |
|
|
121
|
+
| TrackingNum | Shipping tracking number |
|
|
122
|
+
| PrivateNote | Internal notes |
|
|
123
|
+
| CustomerMemo | Customer-facing memo |
|
|
124
|
+
|
|
125
|
+
**Bill Fields:**
|
|
126
|
+
| Field | Description |
|
|
127
|
+
|-------|-------------|
|
|
128
|
+
| Id | Unique bill identifier |
|
|
129
|
+
| DocNumber | Bill/reference number |
|
|
130
|
+
| VendorName | Vendor display name |
|
|
131
|
+
| TxnDate | Bill date |
|
|
132
|
+
| DueDate | Payment due date |
|
|
133
|
+
| TotalAmt | Bill total |
|
|
134
|
+
| Balance | Remaining balance |
|
|
135
|
+
| APAccountName | AP account used |
|
|
136
|
+
| PrivateNote | Internal notes |
|
|
137
|
+
|
|
138
|
+
**Account Fields:**
|
|
139
|
+
| Field | Description |
|
|
140
|
+
|-------|-------------|
|
|
141
|
+
| Id | Unique account identifier |
|
|
142
|
+
| Name | Account name |
|
|
143
|
+
| FullyQualifiedName | Full account path (with parent) |
|
|
144
|
+
| AccountType | Type: Bank, Income, Expense, etc. |
|
|
145
|
+
| AccountSubType | Subtype classification |
|
|
146
|
+
| CurrentBalance | Current account balance |
|
|
147
|
+
| Active | Whether account is active |
|
|
148
|
+
| Classification | Asset, Liability, Equity, Revenue, Expense |
|
|
149
|
+
|
|
150
|
+
**Account Types:**
|
|
151
|
+
| AccountType | Description |
|
|
152
|
+
|-------------|-------------|
|
|
153
|
+
| Bank | Bank and cash accounts |
|
|
154
|
+
| Accounts Receivable | Customer receivables |
|
|
155
|
+
| Accounts Payable | Vendor payables |
|
|
156
|
+
| Income | Revenue accounts |
|
|
157
|
+
| Cost of Goods Sold | COGS accounts |
|
|
158
|
+
| Expense | Operating expense accounts |
|
|
159
|
+
| Fixed Asset | Property, equipment |
|
|
160
|
+
| Other Current Asset | Inventory, prepaid expenses |
|
|
161
|
+
| Other Current Liability | Accrued liabilities |
|
|
162
|
+
| Long Term Liability | Notes payable, mortgages |
|
|
163
|
+
| Equity | Owner's equity, retained earnings |
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
**5. SQL Syntax Reference**
|
|
168
|
+
|
|
169
|
+
**SELECT Statement:**
|
|
170
|
+
```sql
|
|
171
|
+
SELECT column1, column2 FROM TableName WHERE condition ORDER BY column LIMIT n
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
**Operators:**
|
|
175
|
+
| Operator | Description | Example |
|
|
176
|
+
|----------|-------------|---------|
|
|
177
|
+
| = | Equals | `WHERE Balance = 0` |
|
|
178
|
+
| <> | Not equals | `WHERE Status <> 'Paid'` |
|
|
179
|
+
| > | Greater than | `WHERE TotalAmt > 1000` |
|
|
180
|
+
| < | Less than | `WHERE Balance < 500` |
|
|
181
|
+
| >= | Greater or equal | `WHERE TxnDate >= '2024-01-01'` |
|
|
182
|
+
| <= | Less or equal | `WHERE DueDate <= '2024-12-31'` |
|
|
183
|
+
| LIKE | Pattern match | `WHERE CustomerName LIKE 'Acme%'` |
|
|
184
|
+
| IN | In list | `WHERE AccountType IN ('Income','Expense')` |
|
|
185
|
+
| IS NULL | Null check | `WHERE Email IS NULL` |
|
|
186
|
+
| AND | Logical AND | `WHERE Balance > 0 AND DueDate < '2024-01-01'` |
|
|
187
|
+
| OR | Logical OR | `WHERE AccountType = 'Income' OR AccountType = 'Expense'` |
|
|
188
|
+
|
|
189
|
+
**Aggregate Functions:**
|
|
190
|
+
| Function | Description | Example |
|
|
191
|
+
|----------|-------------|---------|
|
|
192
|
+
| SUM() | Sum values | `SELECT SUM(TotalAmt) FROM Invoices` |
|
|
193
|
+
| COUNT() | Count rows | `SELECT COUNT(*) FROM Customers` |
|
|
194
|
+
| AVG() | Average | `SELECT AVG(Balance) FROM Customers` |
|
|
195
|
+
| MIN() | Minimum | `SELECT MIN(TxnDate) FROM Invoices` |
|
|
196
|
+
| MAX() | Maximum | `SELECT MAX(TotalAmt) FROM Bills` |
|
|
197
|
+
|
|
198
|
+
**GROUP BY:**
|
|
199
|
+
```sql
|
|
200
|
+
SELECT CustomerName, SUM(TotalAmt) as Total FROM Invoices GROUP BY CustomerName
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
**6. Example Formulas by Use Case**
|
|
206
|
+
|
|
207
|
+
**Accounts Receivable:**
|
|
208
|
+
=CDATAQUERY("SELECT CustomerName, SUM(Balance) as Outstanding FROM Invoices WHERE Balance > 0 GROUP BY CustomerName ORDER BY Outstanding DESC")
|
|
209
|
+
-> AR aging by customer.
|
|
210
|
+
|
|
211
|
+
=CDATAQUERY("SELECT * FROM Invoices WHERE Balance > 0 AND DueDate < '2024-01-01'")
|
|
212
|
+
-> Overdue invoices.
|
|
213
|
+
|
|
214
|
+
**Accounts Payable:**
|
|
215
|
+
=CDATAQUERY("SELECT VendorName, SUM(Balance) as Outstanding FROM Bills WHERE Balance > 0 GROUP BY VendorName")
|
|
216
|
+
-> AP by vendor.
|
|
217
|
+
|
|
218
|
+
=CDATAQUERY("SELECT * FROM Bills WHERE DueDate BETWEEN '2024-01-01' AND '2024-01-31' AND Balance > 0")
|
|
219
|
+
-> Bills due in January.
|
|
220
|
+
|
|
221
|
+
**Cash Flow:**
|
|
222
|
+
=CDATAQUERY("SELECT TxnDate, TotalAmt, CustomerName FROM Payments WHERE TxnDate >= '2024-01-01' ORDER BY TxnDate")
|
|
223
|
+
-> Customer payments received YTD.
|
|
224
|
+
|
|
225
|
+
=CDATAQUERY("SELECT TxnDate, TotalAmt, VendorName FROM BillPayments WHERE TxnDate >= '2024-01-01' ORDER BY TxnDate")
|
|
226
|
+
-> Vendor payments made YTD.
|
|
227
|
+
|
|
228
|
+
**Chart of Accounts:**
|
|
229
|
+
=CDATAQUERY("SELECT Name, CurrentBalance FROM Accounts WHERE AccountType = 'Bank'")
|
|
230
|
+
-> Bank account balances.
|
|
231
|
+
|
|
232
|
+
=CDATAQUERY("SELECT Name, AccountType, CurrentBalance FROM Accounts WHERE Active = true ORDER BY AccountType, Name")
|
|
233
|
+
-> Active accounts by type.
|
|
234
|
+
|
|
235
|
+
**Revenue Analysis:**
|
|
236
|
+
=CDATAQUERY("SELECT CustomerName, COUNT(*) as InvoiceCount, SUM(TotalAmt) as TotalRevenue FROM Invoices WHERE TxnDate >= '2024-01-01' GROUP BY CustomerName ORDER BY TotalRevenue DESC LIMIT 10")
|
|
237
|
+
-> Top 10 customers by revenue.
|
|
238
|
+
|
|
239
|
+
**Expense Analysis:**
|
|
240
|
+
=CDATAQUERY("SELECT VendorName, COUNT(*) as BillCount, SUM(TotalAmt) as TotalSpend FROM Bills WHERE TxnDate >= '2024-01-01' GROUP BY VendorName ORDER BY TotalSpend DESC LIMIT 10")
|
|
241
|
+
-> Top 10 vendors by spend.
|
|
242
|
+
|
|
243
|
+
**Customer/Vendor Lookup:**
|
|
244
|
+
=CDATAQUERY("SELECT DisplayName, Email, Phone, Balance FROM Customers WHERE DisplayName LIKE '%" & A1 & "%'")
|
|
245
|
+
-> Search customers by name fragment.
|
|
246
|
+
|
|
247
|
+
**General Ledger:**
|
|
248
|
+
=CDATAQUERY("SELECT * FROM JournalEntries WHERE TxnDate BETWEEN '2024-01-01' AND '2024-12-31' ORDER BY TxnDate")
|
|
249
|
+
-> Journal entries for fiscal year.
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
253
|
+
**7. Error Handling**
|
|
254
|
+
|
|
255
|
+
**Common Errors:**
|
|
256
|
+
| Error | Cause | Solution |
|
|
257
|
+
|-------|-------|----------|
|
|
258
|
+
| Connection failed | QuickBooks not connected | Re-authenticate in CData ribbon |
|
|
259
|
+
| Invalid table name | Typo in table name | Check table names in section 3 |
|
|
260
|
+
| Invalid column | Field doesn't exist | Verify field names for that table |
|
|
261
|
+
| Syntax error | SQL syntax issue | Check quotes, operators, parentheses |
|
|
262
|
+
| No data returned | Query too restrictive | Broaden WHERE conditions |
|
|
263
|
+
| Timeout | Query too large | Add LIMIT clause, narrow date range |
|
|
264
|
+
|
|
265
|
+
**Debugging Tips:**
|
|
266
|
+
1. Start with simple query: `SELECT * FROM TableName LIMIT 5`
|
|
267
|
+
2. Add WHERE clauses incrementally
|
|
268
|
+
3. Verify date format: use 'YYYY-MM-DD' or 'MM/DD/YYYY'
|
|
269
|
+
4. String values need single quotes: `WHERE CustomerName = 'Acme Corp'`
|
|
270
|
+
5. Check CData connection status in ribbon
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
**Final Checklist:**
|
|
275
|
+
- What QuickBooks data is needed? (Invoices? Bills? Accounts? Customers?)
|
|
276
|
+
- What time frame is required? (Use TxnDate or DueDate filters)
|
|
277
|
+
- What aggregation is needed? (Raw data vs. SUM/COUNT/GROUP BY)
|
|
278
|
+
- Are the table and field names spelled correctly?
|
|
279
|
+
- Are string values in single quotes?
|
|
280
|
+
- Are dates in proper format?
|
|
281
|
+
- Is LIMIT clause needed to prevent large result sets?
|
|
282
|
+
- Is the CData connection active?
|
|
283
|
+
|
|
284
|
+
---
|
|
285
|
+
|
|
286
|
+
**Additional Resources:**
|
|
287
|
+
- CData QuickBooks Driver Documentation: https://www.cdata.com/drivers/quickbooks/
|
|
288
|
+
- CData Excel Add-in Help: https://cdn.cdata.com/help/DQE/excel/
|
|
289
|
+
- QuickBooks API Field Reference: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities
|