Creepso/agent-desktop
1
0
Fork 0
mirror of https://github.com/lahfir/agent-desktop.git synced 2026-07-26 17:12:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

ci(ffi): ship prebuilt cdylib tarballs for 5 platforms on every release

Browse source 
Every GitHub Release now ships libagent_desktop_ffi.{dylib,so,dll} alongside
the CLI tarballs, so Python / Swift / Go / Ruby / Node / C hosts can download
and dlopen a prebuilt library instead of forking the CLI per call.

- crates/ffi/build.rs: bake install_name=@rpath/libagent_desktop_ffi.dylib
  via rustc-cdylib-link-arg so Swift/SPM consumers resolve through their own
  rpath chain. Verified locally with otool -D on the release-ffi profile.
- .github/workflows/release.yml: new build-ffi matrix job producing
  tarballs for aarch64/x86_64-apple-darwin, x86_64/aarch64-unknown-linux-gnu,
  and x86_64-pc-windows-msvc. Ubuntu 22.04 runner for the Linux glibc floor;
  native ubuntu-22.04-arm runner for aarch64. Each archive contains
  lib/<dylib>, include/agent_desktop.h, LICENSE, and a short README.
- publish-github downloads both binary-* and ffi-* artifacts in one pass,
  concatenates every .sha256 into checksums.txt, and uploads .tar.gz/.zip
  to the release. Asset-count guard bumped 3 → 8.
- actions/attest-build-provenance@v4.1.0 emits keyless Sigstore provenance
  over every release artifact; consumers verify with gh attestation verify.
- LICENSE (Apache-2.0) added at repo root so every FFI tarball can bundle it.
- README: new "Language bindings (FFI)" section with platform→artifact
  table, verify snippet, minimal Python dlopen example, and a link to
  skills/agent-desktop-ffi/.

Verification:
- otool -D target/release-ffi/libagent_desktop_ffi.dylib → @rpath/...
- Simulated workflow staging + tarball + extract + ctypes.CDLL loads from
  extracted lib/ path; 304 KB compressed on darwin-arm64.
- cargo test --lib --workspace: 139 passed (5 suites); clippy clean.
- YAML parses; 6 jobs: release-please, build, build-ffi, publish-github,
  publish-npm, publish-skills.
This commit is contained in:
Lahfir 2026-04-17 03:44:36 -07:00
parent 366f81cc04
commit 2a8b8709b2
4 changed files with 389 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

146
.github/workflows/release.yml vendored
View file

@ -41,7 +41,6 @@ jobs:
timeout-minutes: 30
permissions:
contents: read
# Both arch targets build in parallel; one failure doesn't block the other.
strategy:
fail-fast: false
matrix:
@ -97,24 +96,146 @@ jobs:
agent-desktop-v*.tar.gz.sha256
retention-days: 1
# FFI cdylib for language-binding consumers (Python/Swift/Go/Ruby/Node/C).
# Ships alongside CLI tarballs on the same release tag; npm stays CLI-only.
build-ffi:
name: Build FFI (${{ matrix.target }})
needs: release-please
if: needs.release-please.outputs.release_created == 'true'
runs-on: ${{ matrix.runner }}
timeout-minutes: 30
permissions:
contents: read
strategy:
fail-fast: false
matrix:
include:
- target: aarch64-apple-darwin
runner: macos-latest
archive: tar.gz
lib_name: libagent_desktop_ffi.dylib
- target: x86_64-apple-darwin
runner: macos-latest
archive: tar.gz
lib_name: libagent_desktop_ffi.dylib
- target: x86_64-unknown-linux-gnu
runner: ubuntu-22.04
archive: tar.gz
lib_name: libagent_desktop_ffi.so
- target: aarch64-unknown-linux-gnu
runner: ubuntu-22.04-arm
archive: tar.gz
lib_name: libagent_desktop_ffi.so
- target: x86_64-pc-windows-msvc
runner: windows-latest
archive: zip
lib_name: agent_desktop_ffi.dll
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ needs.release-please.outputs.tag_name }}
- name: Install Rust toolchain
run: |
rustup show
rustup target add ${{ matrix.target }}
- name: Cache cargo registry
uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
with:
path: |
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
key: ${{ runner.os }}-${{ matrix.target }}-ffi-cargo-${{ hashFiles('**/Cargo.toml') }}
restore-keys: ${{ runner.os }}-${{ matrix.target }}-ffi-cargo-
- name: Build FFI cdylib (release-ffi profile)
run: cargo build --profile release-ffi -p agent-desktop-ffi --target ${{ matrix.target }}
# build.rs bakes install_name=@rpath/... ; a regression here silently
# breaks Swift/SPM consumers, so verify before shipping.
- name: Verify macOS install_name
if: runner.os == 'macOS'
shell: bash
run: |
ACTUAL=$(otool -D target/${{ matrix.target }}/release-ffi/${{ matrix.lib_name }} | tail -1)
EXPECTED="@rpath/libagent_desktop_ffi.dylib"
if [ "$ACTUAL" != "$EXPECTED" ]; then
echo "FAIL: install_name is '$ACTUAL', expected '$EXPECTED'"
exit 1
fi
echo "OK: install_name = $ACTUAL"
- name: Stage tarball contents
shell: bash
run: |
VERSION=${{ needs.release-please.outputs.version }}
STAGE="agent-desktop-ffi-v${VERSION}-${{ matrix.target }}"
mkdir -p "$STAGE/lib" "$STAGE/include"
cp "target/${{ matrix.target }}/release-ffi/${{ matrix.lib_name }}" "$STAGE/lib/"
cp crates/ffi/include/agent_desktop.h "$STAGE/include/"
cp LICENSE "$STAGE/"
cat > "$STAGE/README.md" <<EOF
# agent-desktop FFI cdylib — v${VERSION} (${{ matrix.target }})
- \`lib/${{ matrix.lib_name }}\` — shared library
- \`include/agent_desktop.h\` — cbindgen header
- \`LICENSE\` — Apache-2.0
Docs: https://github.com/lahfir/agent-desktop/tree/main/skills/agent-desktop-ffi
macOS \`install_name\` is \`@rpath/libagent_desktop_ffi.dylib\` — linking
consumers need \`-rpath\` pointing at the dylib's directory; \`dlopen\` /
ctypes callers resolve by path and need nothing.
EOF
echo "STAGE=$STAGE" >> "$GITHUB_ENV"
- name: Create archive (Unix)
if: runner.os != 'Windows'
shell: bash
run: |
tar -czf "${STAGE}.tar.gz" "${STAGE}"
shasum -a 256 "${STAGE}.tar.gz" > "${STAGE}.tar.gz.sha256"
- name: Create archive (Windows)
if: runner.os == 'Windows'
shell: pwsh
run: |
Compress-Archive -Path "${env:STAGE}" -DestinationPath "${env:STAGE}.zip"
$hash = (Get-FileHash "${env:STAGE}.zip" -Algorithm SHA256).Hash.ToLower()
"$hash ${env:STAGE}.zip" | Out-File -Encoding ascii "${env:STAGE}.zip.sha256"
- name: Upload artifact
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: ffi-${{ matrix.target }}
path: |
agent-desktop-ffi-v*.tar.gz
agent-desktop-ffi-v*.tar.gz.sha256
agent-desktop-ffi-v*.zip
agent-desktop-ffi-v*.zip.sha256
retention-days: 1
publish-github:
name: Publish to GitHub Release
needs: [release-please, build]
needs: [release-please, build, build-ffi]
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
contents: write
id-token: write # Sigstore OIDC exchange
attestations: write # write provenance bundle back to GitHub
steps:
- name: Download all artifacts
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
with:
pattern: binary-*
pattern: "{binary,ffi}-*"
merge-multiple: true
- name: Create checksums file
run: |
cat *.sha256 > checksums.txt
echo "Checksums:"
cat checksums.txt
- name: Upload assets to GitHub Release
@ -123,9 +244,19 @@ jobs:
GH_REPO: ${{ github.repository }}
run: |
gh release upload ${{ needs.release-please.outputs.tag_name }} \
*.tar.gz checksums.txt \
*.tar.gz *.zip checksums.txt \
--clobber
# Keyless Sigstore provenance. Verify with:
# gh attestation verify <file> --repo lahfir/agent-desktop
- name: Attest build provenance
uses: actions/attest-build-provenance@a2bbfa25375fe432b6a289bc6b6cd05ecd0c4c32 # v4.1.0
with:
subject-path: |
*.tar.gz
*.zip
checksums.txt
publish-npm:
name: Publish to npm
needs: [release-please, publish-github]
@ -148,9 +279,10 @@ jobs:
env:
GH_TOKEN: ${{ github.token }}
run: |
# Expected: 2 CLI tarballs + 4 FFI tarballs + 1 FFI zip + checksums = 8.
ASSETS=$(gh release view ${{ needs.release-please.outputs.tag_name }} --json assets --jq '.assets | length')
if [ "$ASSETS" -lt 3 ]; then
echo "FAIL: expected at least 3 assets (2 tarballs + checksums), found ${ASSETS}"
if [ "$ASSETS" -lt 8 ]; then
echo "FAIL: expected at least 8 assets, found ${ASSETS}"
exit 1
fi
echo "OK: ${ASSETS} assets found on release"

202
LICENSE Normal file
View file

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

33
README.md
View file

@ -11,6 +11,7 @@
## Key Features
- **Native Rust CLI**: Fast, single binary, no runtime dependencies
- **C-ABI cdylib** (`libagent_desktop_ffi`): Load once from Python / Swift / Go / Ruby / Node / C instead of forking the CLI per call
- **53 commands**: Observation, interaction, keyboard, mouse, notifications, clipboard, window management
- **Progressive skeleton traversal**: 78–96% token reduction on dense apps via shallow overview + targeted drill-down
- **Snapshot & refs**: AI-optimized workflow using deterministic element references (`@e1`, `@e2`)
@ -51,6 +52,38 @@ macOS requires Accessibility permission. Grant it in **System Settings > Privacy
agent-desktop permissions --request # trigger system dialog
```
## Language bindings (FFI)
Every GitHub Release ships a prebuilt C-ABI cdylib alongside the CLI tarballs. Hosts that need in-process calls (Python agents, Swift apps, Go services, Node tools, Ruby scripts, C/C++ code) `dlopen` the dylib and call the functions declared in `agent_desktop.h` — no fork-exec per command.
| Platform | Artifact |
|----------------------|----------|
| macOS arm64 | `agent-desktop-ffi-v<ver>-aarch64-apple-darwin.tar.gz` |
| macOS x86_64 | `agent-desktop-ffi-v<ver>-x86_64-apple-darwin.tar.gz` |
| Linux x86_64 (glibc) | `agent-desktop-ffi-v<ver>-x86_64-unknown-linux-gnu.tar.gz` |
| Linux arm64 (glibc) | `agent-desktop-ffi-v<ver>-aarch64-unknown-linux-gnu.tar.gz` |
| Windows x86_64 (MSVC)| `agent-desktop-ffi-v<ver>-x86_64-pc-windows-msvc.zip` |
Each archive contains `lib/libagent_desktop_ffi.{dylib,so,dll}`, `include/agent_desktop.h`, `LICENSE`, and a short README. Verify the download with the release's `checksums.txt`:
```bash
shasum -a 256 -c checksums.txt
gh attestation verify agent-desktop-ffi-v*.tar.gz --repo lahfir/agent-desktop # Sigstore provenance
```
Minimal Python round-trip:
```python
import ctypes
lib = ctypes.CDLL("./lib/libagent_desktop_ffi.dylib")
lib.ad_adapter_create.restype = ctypes.c_void_p
adapter = lib.ad_adapter_create()
# ... call ad_list_apps / ad_get_tree / ad_execute_action, see docs below
lib.ad_adapter_destroy(adapter)
```
Full consumer guide — error-handling contract, ownership rules, threading constraints, every entrypoint with Safety docs: [`skills/agent-desktop-ffi/`](skills/agent-desktop-ffi/).
## Core Workflow for AI
For dense apps (Slack, VS Code, Notion), use **progressive skeleton traversal** to minimize token usage:

15
crates/ffi/build.rs
View file

@ -5,6 +5,21 @@ fn main() {
println!("cargo:rerun-if-changed=cbindgen.toml");
println!("cargo:rerun-if-changed=src/");
// macOS Mach-O install_name: consumers that link the dylib at build
// time (Swift Package Manager, cmake, meson) embed the library's
// install_name into the consuming binary's load commands. Cargo
// defaults to the absolute build-machine path — useless once the
// dylib is extracted from a release tarball on someone else's
// machine. Baking `@rpath/...` here lets consumers resolve the
// library through their own `-rpath` / `DYLD_LIBRARY_PATH` /
// `@loader_path` lookup chain exactly the way every other
// distributed macOS dylib does it (wasmtime, rustls-ffi, etc.).
// Python `ctypes.CDLL("./libfoo.dylib")` and Go cgo tolerate either
// install_name; Swift linkers do not.
if std::env::var("CARGO_CFG_TARGET_OS").as_deref() == Ok("macos") {
println!("cargo:rustc-cdylib-link-arg=-Wl,-install_name,@rpath/libagent_desktop_ffi.dylib");
}
let crate_dir = match env::var("CARGO_MANIFEST_DIR") {
Ok(d) => d,
Err(_) => {