Belgeleri incele
Kılavuzlar
Uygulamanızı veya ajanınızın çalışmasını çalıştırın CLI görevler hakkında görevler Linux veya veya veya DockerSonra erişimi doğrulayın ve bir yeniden başlatmadan sonra tekrarlayın.
Bu sayfada
1. runtime seçin
Linux ile Bash ve jq ve bir sahibi API anahtarı ile google_search izni. Görevi yapacak OS kullanıcısı olarak kurulum yapın. 1–4 adımları için bu özel görev klasörü oluşturun; dosya etiketleri herhangi bir alt katlayıcı gösterir.
umask 077
mkdir -p "$HOME/flashdata-tasks/deployment-check"
cd "$HOME/flashdata-tasks/deployment-check"Önce yerli CLI'u yükleyin. Run command -v flashdata to find its absolute road, then set FLASHDATA_BIN to that road in runtime.sh. Bir kez burada profil adını ve kalıcı devlet yolunu ayarlayın, sonra dosyayı kurtar.
# runtime.sh — edit the executable and persistent state paths.
export FLASHDATA_BIN=/usr/local/bin/flashdata
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"
run_flashdata() {
env -u FLASHDATA_API_KEY "$FLASHDATA_BIN" "$@" \
--profile "$FLASHDATA_PROFILE" \
--state-dir "$FLASHDATA_STATE_DIR"
}Linux Docker ile ev sahibi curl, tar ve sha256sum, ev sahibi CPU için pinned CLI indir. image/Dockerfile ve image/.dockerignore'u aşağıda, resmi inşa edin, sonra runtime.sh'yu kurtar. Yardımcı UID/GID olarak çalışır ve her yeni konteynere devlet ve görev klasörlerini koyar.
(
set -euo pipefail
case "$(uname -m)" in
x86_64) arch=amd64 ;;
aarch64|arm64) arch=arm64 ;;
*) echo 'Use a Linux amd64 or arm64 host.' >&2; exit 1 ;;
esac
mkdir -p image
cd image
archive="flashdata_1.2.1_linux_$arch.tar.gz"
base='https://github.com/flashdatadev/flashdata-cli/releases/download/v1.2.1'
curl --fail --show-error --location "$base/$archive" -o "$archive"
curl --fail --show-error --location "$base/SHA256SUMS" -o SHA256SUMS
awk -v file="$archive" '$2 == file { print }' SHA256SUMS | sha256sum -c -
tar -xzf "$archive" flashdata
)FROM debian:bookworm-slim
RUN apt-get update \
&& apt-get install -y --no-install-recommends ca-certificates \
&& rm -rf /var/lib/apt/lists/*
COPY --chmod=0755 flashdata /usr/local/bin/flashdata
USER 10001:10001
ENTRYPOINT ["/usr/local/bin/flashdata"]*
!Dockerfile
!flashdatadocker build --tag flashdata-runtime:1.2.1 ./image
docker run --rm flashdata-runtime:1.2.1 --version# runtime.sh — use the local image built above.
export FLASHDATA_IMAGE='flashdata-runtime:1.2.1'
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"
run_flashdata() {
docker run --rm -i --user "$(id -u):$(id -g)" \
--env FLASHDATA_API_KEY= \
--mount "type=bind,src=$FLASHDATA_STATE_DIR,dst=/state" \
--mount "type=bind,src=$PWD,dst=/work" --workdir /work \
--entrypoint /usr/local/bin/flashdata "$FLASHDATA_IMAGE" \
"$@" --profile "$FLASHDATA_PROFILE" --state-dir /state
}Seçilmiş runtime kontrol edin
Görev klasöründen hareket edin. run_flashdata Yardımcı kurtarıldı runtime.shDaha sonra tüm komutlar profil ve eyalet rehberini kullanır. FLASHDATA_API_KEY’u görmezden gelir, böylece bir ortam anahtarı kurtarılan profili değiştiremez. CLI ve jq versiyonlarını bekleyin.
set -euo pipefail
umask 077
. ./runtime.sh
mkdir -p "$FLASHDATA_STATE_DIR"
chmod 700 "$FLASHDATA_STATE_DIR"
run_flashdata --version
jq --version2. Yükleme sahibi bir kez birden bir kez erişim
Profil zaten sahibi erişimi varsa, ithalat atlayın ve aşağıdaki kontrolü çalıştırın. Aksi takdirde, bir sahibi anahtar gizli dosyayı servis kullanıcısı tarafından okunabilir ve onun konumuyla örnek yolu değiştirir. import bunu stdin aracılığıyla okur; Docker, onu görüntüye kopyalamaz.
export FLASHDATA_KEY_FILE='/run/secrets/flashdata_api_key'set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Set the path to your mounted owner-key secret}"
run_flashdata auth login --api-key-stdin --non-interactive \
< "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactiveHesabı ve izni onaylayın
Kontrol hesabı ID'u yazdırır, kaynakları ve şifreli koruma sağlar, sonra true. Hesap ID, devam etmeden önce amaçlanan sahibidir. access.json denetim için görev klasöründe kalır.
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata auth status --json --non-interactive > access.json
jq '{accountId: .data.identity.identity.accountId,
sources: .data.identity.permittedSources,
credentialProtection: .data.credentialProtection}' access.json
jq -e '.ok and .data.accessVerified
and (.data.identity.identity.recurringAllowed == true)
and (.data.identity.permittedSources | index("google_search") != null)' access.jsonCredential depolama ve kalıcı dosyalar
data.credentialProtection'de auth status. Linux, bir anahtarsız ev sahibi veya yukarıdaki konteyner bir sahibi yalnızca basit bir metin dosyası kullanabilir. Devlet rehberi özel ve kalıcı tut. Kullanıcıyı dizüstü bilgisayarın şifreli profilinden ayrı bir şekilde rezerve edin.
| Keep Keep Keep | Konum Konum Location |
|---|---|
| Credentials and run magazine | FLASHDATA_STATE_DIR |
| Giriş, makbuzlar ve sonuçlar | Görev klasörü; /work olarak Docker olarak monte edildi. |
3. İstekyi ve maliyeti doğrulayın
request.json'un yanında runtime.sh'u kurtarın. Aşağıdaki kontrol tekrarlanan erişim ve istek, mevcut fiyatlandırmayı okur ve mevcut denge ile karşılaştırır. Bu hiçbir arama sunar ve kredi rezervu etmez. Sadece filtre basıldığında true.
{
"source": "google_search",
"query": "battery recycling research",
"params": {
"num": 5
}
}set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata account balance --json --non-interactive > balance.json
run_flashdata query --input request.json --mode realtime --dry-run --recurring \
--run-id deployment-first-task --json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
.ok and .data.dryRun and .data.estimateAvailable
and ($balance[0].ok == true)
and any(.data.estimate.prices[]?;
.source == "google_search" and .available == true
and (.estimatedCredits | type == "number")
and ($balance[0].data.availableCredits | type == "number")
and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json4. Bir kez çalıştırın ve yeniden doğrulayın
Aşağıdaki deployment-check.sh'u kurtarın. Yeni bir dağıtım-ilk-task ile ID, ilk infaz bir ücretli arama gönderir; ikincisi yeni bir süreç başlatır ve kaydedilen sonucu okur. Eğer bu ID zaten aynı profilde tamamlandıysa, her ikisi de onu yeniden kullanmaya çalışır.
Save Kaydet deployment-check.sh
Create Create CreateCreate Create Create deployment-check.sh yanında başka bir yerde runtime.sh Ve ve request.json Özel görev klasörü ev sahibi üzerinde. Aşağıdaki tam senaryoyu kopyalayın ve onu kurtarın.
#!/usr/bin/env bash
set -euo pipefail
umask 077
cd -- "$(dirname -- "$0")"
. ./runtime.sh
attempt=$(mktemp -d ./deployment-check.XXXXXX)
printf 'Attempt files: %s\n' "$attempt" >&2
cp -- request.json "$attempt/request.json"
if ! run_flashdata query --input "$attempt/request.json" --mode realtime --recurring \
--run-id deployment-first-task --timeout 2m --json --non-interactive \
--output "$attempt/result.json" \
> "$attempt/receipt.json" 2> "$attempt/error.json"; then
cat "$attempt/error.json" >&2
exit 1
fi
jq -e '.ok == true' "$attempt/receipt.json" >/dev/null
jq -e '.source == "google_search" and .status == "done"
and (.results[0].organic | type == "array")' "$attempt/result.json" >/dev/null
jq '{runId, cached, usage}' "$attempt/receipt.json"
printf 'Saved result: %s\n' "$attempt/result.json"Kurtarılan çeki iki kez çalıştırın
Bu ev sahibi görev klasöründen aynı hizmet kullanıcısı olarak çalıştırın. Her iki işlem de runtime.sh'nun 1'ya adım atmasını sağlar.
# A new run ID submits one paid search; a completed ID reuses its result.
bash deployment-check.sh
# New process; Docker uses a new container with the same mounts.
# Same account, input and state: cached: true, no new search.
bash deployment-check.shİkinci makbuzunu doğrulayın
Yeni bir iş için, cached: false'yu bekleyin, sonra cached: true. Her girişim deployment-check.XXXXXX klasörünü yazdırır ve request.json, receipt.json ve error.json, artı result.json'u başarıyla kurtarır. Önbellekli makbuz orijinal kullanımları bildiriyor. Başarısız bir girişim, kurtarma için dosyalarını tutar.
{
"ok": true,
"runId": "deployment-first-task",
"cached": true
}Kurtarılan arama sonucunu okuyun
ATTEMPT_DIR'u yukarıda yayınlanan ikinci başarılı klasöre ayarlayın, örneğin ATTEMPT_DIR='./deployment-check.ABC123'yu ihraç edin. Bu komutlar sadece yerel dosyaları okur.
# Use one attempt folder printed by deployment-check.sh.
: "${ATTEMPT_DIR:?Set a saved deployment-check.XXXXXX folder}"
jq '{runId, cached, usage}' "$ATTEMPT_DIR/receipt.json"
jq '.results[0].organic[] | {title, link, snippet}' "$ATTEMPT_DIR/result.json"Tekrarlanan bir görev için bir dağıtım kontrolünden hareket edin
Bu kontrol, sabit bir ID'ya sahiptir. Tekrarlanan çalışma için, her biri kendi ID'unu meydana getirmek ve seçilmiş runtime, hesap, giriş anlıkları ve devlet dağları tutmak amaçlanmıştır. Tekrarlanan koşucunun sorgu komutunu run_flashdata kullanmak için uyarlayın, böylece Docker görevleri konteyner içinde kalır.
GitHub Actions'dan kontrol edin
Linux koşucusu Bash, jq ve CLI profili zaten koşucunun OS kullanıcısı altında kuruldu. Uygulamanızın repository'sinde bu iş akışı tasarruf edin. Ev sahibi CLI'u ücretli bir görev almadan kontrol eder.
- flaşdata-araştırma etiketini o koşucuya imzalayın.
- Set repository değişkenleri FLASHDATA_BIN ve FLASHDATA_STATE_DIR'yu mutlak yollara ve FLASHDATA_PROFILE'u şu anki profil adına ayarlayın.
name: FlashData access check
on: workflow_dispatch
permissions: {}
concurrency:
group: flashdata-research
cancel-in-progress: false
jobs:
verify:
runs-on: [self-hosted, linux, flashdata-research]
timeout-minutes: 5
steps:
- name: Verify the installed profile without a paid query
shell: bash
env:
FLASHDATA_BIN: ${{ vars.FLASHDATA_BIN }}
FLASHDATA_STATE_DIR: ${{ vars.FLASHDATA_STATE_DIR }}
FLASHDATA_PROFILE: ${{ vars.FLASHDATA_PROFILE }}
FLASHDATA_API_KEY: ""
run: |
set -euo pipefail
: "${FLASHDATA_BIN:?Set the absolute CLI path}"
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
: "${FLASHDATA_PROFILE:?Set the installed profile name}"
test -d "$FLASHDATA_STATE_DIR"
"$FLASHDATA_BIN" auth status --profile "$FLASHDATA_PROFILE" \
--state-dir "$FLASHDATA_STATE_DIR" --json --non-interactive |
jq -e '.ok and .data.accessVerified
and (.data.identity.identity.recurringAllowed == true)
and (.data.identity.permittedSources | index("google_search") != null)'Access check
Boşlukların varsayılan kolundaki iş akışının ardından, açık Eylemler → FlashData erişim kontrolü → Run iş akışı. true ve başarılı bir kontrol bekleyin. Eksik erişim veya izin, bir arama göndermeden işi başarısız eder.
İş işleri boyunca yürütme devleti tutun
Bir ephemeral koşucu orijinal dergi olmadan başlar. Tekrarlanan iş için kalıcı bir başvuru durumu veya kalıcı bir koşucu kullanın. Sadece anahtarı yeniden yüklemek önceki bir işin teklifini tanımlayamaz. Devlet rehberi ve görev çıktılarını özel tut; onları CI eserleri olarak yüklemeyin.
Rotate veya geri dönüş dağıtılmış erişim
Pause sent. Görev klasöründe, FLASHDATA_KEY_FILE aynı hesap ve gerekli kaynaklar için bir yedek anahtarla, sonra aşağıdaki komutları çalıştırın. Erişim kontrolü ve deployment-check.sh; cached: true’yu bekleyin. Doğrulamadan sonra eski anahtarı uyandırın ve profili ve eyalet dizisini tut.
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Point to the mounted replacement key for the same account}"
run_flashdata auth login --replace --api-key-stdin --non-interactive \
< "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactiveerişim tamamen durdurun
Programcıyı kullanın, konsoldaki anahtar veya ajan bağlantısını geri alın, sonra ücretsiz erişim kontrolünü tekrarlayın. Başarısız olması gerekir. Yerel logout sadece sunucuyu geri çevirmez; zaten ihraç edilen dosyalar diskte kalır.
Deployment, başarısız olan kontrolleri kontrol eder
| Symptom | Fix Fix |
|---|---|
| Komut bulunamadı / yanlış CLI sürüm | Check command -v flashdata ve FLASHDATA_BIN'de runtime.sh. Docker için, görüntünün --version kontrolünü yeniden inşa edin ve çalıştırın. |
| Eksik dağ veya izin inkar etti | Docker host'ta devlet ve görev klasörleri oluşturun, servis UID/GID. Yollarını istikrarlı tut. |
| replacement_requires_flag | Profilin farklı bir kurtarılmış anahtarı vardır. Mevcut erişimi ilk önce doğrulayın; amaçlanan bir yedek için rotasyon prosedürü kullanın. |
| Şifreyi kurtaramaz | Bunu sağlayan kullanıcı olarak, aynı credential-store ortamında çalıştırın. Şifreli bir dizüstü bilgisayar profili kopyalamak yerine yeni bir destinasyona erişim. |
| Maliyet kontrolü false | Inspect balance.json ve preflight.json. Mevcut bir fiyat, kaynak izni ve teslim etmeden önce yeterli bir dengeye gerek. |
| run_account_mismatch | Seçilen hesabı ve API kökenlerini kontrol edin. Orijinal erişimi geri yükleme; kurtarmayı atlamak için koşmayı isimlendirmeyin. |
| run_id_input_conflict | Deneyin request.json'dan orijinal isteği geri yükleyin. Yeni bir run ID'u sadece amaçlanan yeni ücretli bir görev için kullanın. |
| CI kalır kuyruk | koşucunun online olduğunu ve her koşu etiketine sahip olduğunu kontrol edin. Bu iş akışı, Linux koşucusu ağırlayan kalıcı bir kendini gerektirir. |