Gemini Key Management System

https://gkd.li/
Admin
This project provides backend services for managing Gemini API keys and related operations, likely...
Tokens:34,064
Snippets:469
Trust Score:7.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### context.getPrev() Method Examples

Source: https://gkd.li/guide/example

Examples using the `getPrev()` method to access previous sibling nodes and apply screen position constraints.

```GKD Selector
@[clickable=true][right<getPrev(1).width.div(2)] >(1,2) [vid="cover"] <<n [parent=null]
```

```GKD Selector
@[clickable=true][left>getPrev(1).width.div(2)][top>getPrev(1).height.div(2)] >(1,2) [vid="cover"] <<n [parent=null]
```

--------------------------------

### node.getChild() Method Examples

Source: https://gkd.li/guide/example

Examples demonstrating the use of the `getChild()` method to access child nodes by index.

```GKD Selector
ViewGroup[desc^="直播"][getChild(0).vid="cover_layout"]
```

```GKD Selector
ViewGroup[desc^="直播"][getChild(2).getChild(0).name$="TextView"]
```

```GKD Selector
ViewGroup[desc^="直播"][getChild(childCount.minus(1)).vid="more"]
```

--------------------------------

### Correct Snapshot Link Example

Source: https://gkd.li/guide/snapshot

This is an example of the correct way to share a snapshot link. This link, generated from the snapshot page's share option, is universally accessible.

```text
https://i.gkd.li/i/18135562
```

--------------------------------

### Global Rule Example

Source: https://gkd.li/guide/subscription

An example of a global rule for GKD, designed to block splash ads across the application. It includes parameters for matching, action limits, and reset conditions.

```json5
{
  key: 0,
  name: '开屏广告',
  fastQuery: true,
  matchTime: 10000,
  actionMaximum: 1,
  resetMatch: 'app',
  rules: [
    {
      key: 0,
      matches: '[text*="跳过"][text.length<10][visibleToUser=true]',
    },
  ],
}
```

--------------------------------

### Application Rule Example

Source: https://gkd.li/guide/subscription

A simple example of an application rule for GKD, specifying rules for the Zhihu app. This rule targets an element with a specific ID for skipping splash ads.

```json5
{
  id: 'com.zhihu.android',
  name: '知乎',
  groups: [
    {
      key: 0,
      name: '开屏广告',
      rules: { matches: 'TextView[id="com.zhihu.android:id/btn_skip"]' },
      snapshotUrls: ['https://i.gkd.li/i/13070251'],
    },
  ],
}
```

--------------------------------

### ADB Authorization Failure Example

Source: https://gkd.li/guide/faq

This is an example of a SecurityException that may occur when attempting to grant runtime permissions via ADB, indicating insufficient privileges or incorrect configuration.

```text
adb shell pm grant li.songe.gkd android.permission.WRITE_SECURE_SETTINGS

Exception occurred while executing 'grant':
java.lang.SecurityException: grantRuntimePermission: Neither user 2000 nor current process has android.permission.GRANT_RUNTIME_PERMISSIONS.
  at android.app.ContextImpl.enforce(ContextImpl.java:2384)
  at android.app.ContextImpl.enforceCallingOrSelfPermission(ContextImpl.java:2412)
  at com.android.server.pm.permission.PermissionManagerServiceImpl.grantRuntimePermissionInternal(PermissionManagerServiceImpl.java:1383)
  at com.android.server.pm.permission.PermissionManagerServiceImpl.grantRuntimePermission(PermissionManagerServiceImpl.java:1365)
  at com.android.server.pm.permission.PermissionManagerService.grantRuntimePermission(PermissionManagerService.java:573)
  at android.permission.PermissionManager.grantRuntimePermission(PermissionManager.java:610)
  at com.android.server.pm.PackageManagerShellCommand.runGrantRevokePermission(PackageManagerShellCommand.java:2717)
  at com.android.server.pm.PackageManagerShellCommand.onCommand(PackageManagerShellCommand.java:301)
  at com.android.modules.utils.BasicShellCommandHandler.exec(BasicShellCommandHandler.java:97)
  at android.os.ShellCommand.exec(ShellCommand.java:38)
  at com.android.server.pm.PackageManagerService$IPackageManagerImpl.onShellCommand(PackageManagerService.java:6840)
  at android.os.Binder.shellCommand(Binder.java:1092)
  at android.os.Binder.onTransact(Binder.java:912)
  at android.content.pm.IPackageManager$Stub.onTransact(IPackageManager.java:4352)
  at com.android.server.pm.PackageManagerService$IPackageManagerImpl.onTransact(PackageManagerService.java:6824)
  at android.os.Binder.execTransactInternal(Binder.java:1392)
  at android.os.Binder.execTransact(Binder.java:1299)
```

--------------------------------

### Select Root Node

Source: https://gkd.li/guide/example

Examples for selecting the root node of the UI hierarchy.

```GKD Selector
[parent=null]
```

```GKD Selector
[depth=0]
```

--------------------------------

### Incorrect Snapshot Link Example

Source: https://gkd.li/guide/snapshot

This is an example of an incorrect way to share a snapshot link. This type of link may only work in the current browser session and will show 'Snapshot missing' on other devices.

```text
https://i.gkd.li/snapshot/1734099604908
```

--------------------------------

### Application Rule Group Example

Source: https://gkd.li/guide/subscription

An example of an application rule group for GKD, used to define rules for full-screen ads or member activity pop-ups. It specifies matching conditions and snapshot URLs.

```json5
{
  key: 1,
  name: '全屏广告-会员活动弹窗',
  rules: [
    {
      key: 0,
      fastQuery: true,
      activityIds: 'com.blued.android.core.ui.TransparentActivity',
      matches: '[vid="img_close"]',
      snapshotUrls: 'https://i.gkd.li/i/14310618',
    },
  ],
}
```

--------------------------------

### Relationship Selector Example

Source: https://gkd.li/guide/selector

Illustrates the basic syntax of a relationship selector, showing how to specify the relationship between two attribute selectors.

```GKD Selector
div > img
```

--------------------------------

### Select Sibling Nodes

Source: https://gkd.li/guide/example

Examples for selecting nodes based on their sibling relationships.

```GKD Selector
ViewGroup[desc="个人主页，按钮"] + LinearLayout[desc="搜索栏，按钮"]
```

```GKD Selector
@LinearLayout[desc="搜索栏，按钮"] - ViewGroup[desc="个人主页，按钮"]
```

```GKD Selector
[vid="cover_layout"] +n [text$="顶级入耳"]
```

```GKD Selector
@[text$="顶级入耳"] -n [vid="cover_layout"]
```

--------------------------------

### Reset rule on app re-entry

Source: https://gkd.li/api/interfaces/rawcommonprops

This example shows how to reset a rule when the user re-enters the application.

```typescript
'app'
```

--------------------------------

### Select Parent Nodes

Source: https://gkd.li/guide/example

Examples for selecting parent nodes based on their child nodes.

```GKD Selector
FrameLayout[vid="cover_layout"] < ViewGroup[desc^="直播"]
```

```GKD Selector
ViewGroup[vid="live_text_container"] <3 ViewGroup[desc^="直播"]
```

```GKD Selector
TextView[vid="title_v2"] <n ViewGroup[desc^="直播"]
```

--------------------------------

### Attribute Selector Example

Source: https://gkd.li/guide/selector

Demonstrates various attribute selection criteria including equality, prefix, substring, and negation. It shows how to match node names, use logical operators (||, &&), and handle boolean expressions.

```GKD Selector
@TextView[a=1][b^='2'][c*='a'||d.length>7&&e=false][!(f=true)][g.plus(1)>0]
```

--------------------------------

### Identifier Validation Example

Source: https://gkd.li/guide/selector

Illustrates valid and invalid identifiers used in selectors. Identifiers must start with a letter or underscore and can contain letters, numbers, and underscores.

```GKD Selector
a
ikun
manbaout
```

```GKD Selector
a.1
a.null
a.true
```

--------------------------------

### Position Value Examples

Source: https://gkd.li/api/type-aliases/position

Demonstrates valid numeric and string formats for position values, including mathematical expressions and dynamic screen parameters.

```typescript
2.5 // ✅
'2.5' // ✅
'2.5 + 1 - 2 * 3 / 4 ^ 5 % 6' // ✅
'(right + left) / 2' // ✅
```

--------------------------------

### Select Child Nodes

Source: https://gkd.li/guide/example

Examples for selecting child nodes based on their parent or ancestor nodes.

```GKD Selector
LinearLayout > ImageView
```

```GKD Selector
ViewGroup[vid="avatar_layout"] >2 ImageView
```

```GKD Selector
FrameLayout[vid="content_layout"] >n ImageView[vid="search_icon"]
```

--------------------------------

### Integer Example

Source: https://gkd.li/api/type-aliases/Integer

Demonstrates valid and invalid values for the Integer type. Use whole numbers for valid integers.

```typescript
114514 // ✅
2.5 // ❌
```

--------------------------------

### Tuple and Polynomial Expressions

Source: https://gkd.li/guide/selector

Demonstrates the use of tuple and polynomial expressions to define ranges for relationship selectors. Includes examples of finite and infinite ranges.

```GKD Selector
(1)
(2,3,5)
```

```GKD Selector
(-n+4)
(-3n+10)
```

```GKD Selector
(n)
(2n-1)
```

--------------------------------

### Check Update JSON Example

Source: https://gkd.li/api/interfaces/RawSubscription

This JSON structure is used for checking subscription updates. It requires an 'id' and 'version' to compare against the current subscription.

```json5
{
  id: 114514,
  version: 1919810
}
```

--------------------------------

### IArray<T> Usage Examples

Source: https://gkd.li/api/type-aliases/IArray

Demonstrates how to use the IArray<T> type alias with numbers and strings. It shows valid assignments for both single values and arrays.

```typescript
const n1: IArray<number> = 1; // ✅
const n2: IArray<number> = [1]; // ✅
const s1: IArray<string> = 'hello'; // ✅
const a2: IArray<string> = ['hello']; // ✅
```

--------------------------------

### Reset rule on interface match change

Source: https://gkd.li/api/interfaces/rawcommonprops

This example demonstrates resetting a rule when the interface changes from a non-matching state to a matching state within the application.

```typescript
'match'
```

--------------------------------

### Click Screen Center

Source: https://gkd.li/api/type-aliases/position

Use 'screenWidth/2' and 'screenHeight/2' to position the click at the center of the screen.

```json5
{
 x: 'screenWidth/2',
 y: 'screenHeight/2',
}
```

--------------------------------

### SwipeArg

Source: https://gkd.li/api/type-aliases/SwipeArg

Defines the structure for swipe gesture arguments, including start and end positions and duration.

```APIDOC
## SwipeArg

> **SwipeArg** = `object`

### Properties

#### start

> **start** : `Position`
> 
> Starting coordinates. Calculated in the same way as Position.

#### end (optional)

> `optional` **end** : `Position`
> 
> Ending coordinates. Calculated in the same way as Position. Defaults to the start position.
> If the start and end coordinates are identical, it can be used as a click with custom duration.

#### duration

> **duration** : `Integer`
> 
> Swipe duration in milliseconds. The swipe curve is linear.
```

--------------------------------

### Select Last Child Node

Source: https://gkd.li/guide/example

Example for selecting a node that is the last child of its parent.

```GKD Selector
ImageView[index=parent.childCount.minus(1)]
```

--------------------------------

### Combined Selector Usage

Source: https://gkd.li/guide/example

An example of a complex selector combining multiple criteria for precise targeting.

```GKD Selector
ImageView < FrameLayout <n ViewGroup[desc^="直播"] - ViewGroup >4 FrameLayout[index=0] +2 FrameLayout > @TextView[index=parent.childCount.minus(1)] <<n FrameLayout[vid="content"]
```

--------------------------------

### Basic Empty Subscription File

Source: https://gkd.li/guide/subscription

This is the most basic structure for an empty subscription file using JSON5 syntax. It includes essential metadata for a GKD subscription.

```json5
// gkd.json5
{
  id: 233,
  name: 'Subscription',
  version: 0,
  author: 'author',
  updateUrl: 'https://gist.github.com/lisonge/3f5693182ad4ef5e307be760dba22bcb/raw/gkd.json5',
  checkUpdateUrl: 'https://gist.github.com/lisonge/3f5693182ad4ef5e307be760dba22bcb/raw/gkd.json5',
  supportUri: 'https://gkd.li/',
  categories: [],
  globalGroups: [],
  apps: [],
}
```

--------------------------------

### Find Specific Selector Within Children

Source: https://gkd.li/guide/example

Examples for finding a specific selector within the children of a given node.

```GKD Selector
@[text="直播"] <<n ViewGroup[vid="live_text_container"]
```

```GKD Selector
LinearLayout > @[text="直播"] <<n [vid="swipe_layout"]
```

--------------------------------

### Capture Snapshot via Service Call

Source: https://gkd.li/guide/snapshot

This snippet demonstrates how to capture a snapshot by calling an internal GKD service using a shell script. Ensure the 'expose.sh' script is available in the specified path.

```sh
sh /storage/emulated/0/Android/data/li.songe.gkd/files/sh/expose.sh
```

--------------------------------

### RawApp

Source: https://gkd.li/api

Represents the application rule configuration for an app.

```APIDOC
## Interface RawApp

### Description
Represents the application rule configuration for an app.

### Endpoint
N/A (Interface definition)
```

--------------------------------

### Click Target Node Center

Source: https://gkd.li/api/type-aliases/position

Use 'width/2' and 'height/2' to position the click at the center of the target node.

```json5
{
 left: 'width/2',
 top: 'height/2',
}
```

--------------------------------

### Subscription File URL

Source: https://gkd.li/guide/subscription

This is the direct URL to a GKD subscription file, which can be used to add the subscription to the application.

```txt
https://gist.github.com/lisonge/3f5693182ad4ef5e307be760dba22bcb/raw/gkd.json5
```

--------------------------------

### RawAppRule

Source: https://gkd.li/api

Represents an application rule.

```APIDOC
## Interface RawAppRule

### Description
Represents an application rule.

### Endpoint
N/A (Interface definition)
```

--------------------------------

### Click Target Node Top-Left Corner

Source: https://gkd.li/api/type-aliases/position

Use '0' for left and top to position the click at the top-left corner of the target node.

```json5
{
 left: 0,
 top: 0,
}
```

--------------------------------

### Find TextView with specific ID and text, parent is LinearLayout

Source: https://gkd.li/guide/selector

This selector finds a TextView with a specific ID and text, ensuring its parent is a LinearLayout. The search starts from the right, identifying the TextView first, then checking its parent. The target node is specified as the LinearLayout.

```selector
@LinearLayout > TextView[id=`com.byted.pangle:id/tt_item_tv`][text=`不感兴趣`]
```

--------------------------------

### RawGlobalApp

Source: https://gkd.li/api

Represents the application configuration for a global rule.

```APIDOC
## Interface RawGlobalApp

### Description
Represents the application configuration for a global rule.

### Endpoint
N/A (Interface definition)
```

--------------------------------

### IntegerMatcher

Source: https://gkd.li/api/type-aliases/IntegerMatcher

Defines rules for matching integers. The priority order is exclude > include > (minimum/maximum).

```APIDOC
## IntegerMatcher

### Description
Defines rules for matching integers. The priority order is exclude > include > (minimum/maximum).

### Properties
#### exclude
- **exclude** (IArray<Integer>) - Optional - If in this list, the integer is excluded from matching.

#### include
- **include** (IArray<Integer>) - Optional - If not in this list, the integer is excluded from matching.

#### minimum
- **minimum** (Integer) - Optional - If less than this value, the integer is excluded from matching.

#### maximum
- **maximum** (Integer) - Optional - If greater than this value, the integer is excluded from matching.
```

--------------------------------

### Simplified regex optimization: startsWith

Source: https://gkd.li/guide/selector

When a regular expression matches the pattern `abc.*` (case-insensitive), it is optimized to a `startsWith` function call.

```selector
[text~="(?is)abc.*"]
```

--------------------------------

### RawAppRule Properties

Source: https://gkd.li/api/interfaces/rawapprule

This section details the configurable properties of the RawAppRule interface. These properties allow for fine-grained control over how rules are applied, including timing, matching logic, and execution limits.

```APIDOC
## RawAppRule Properties

### actionCd? 
> `optional` **actionCd** : `Integer`
单位: 毫秒
当前规则的冷却时间, 或者执行 action 最小间隔
#### Default 
ts```
1000
```

### fastQuery? 
> `optional` **fastQuery** : `boolean`
如果开启, 此规则下的所有满足 **特定格式的选择器** 将使用快速查找优化查询速度
详细文档请查看 查询优化
#### Default 
ts```
false
```

### matchRoot? 
> `optional` **matchRoot** : `boolean`
此规则下的所有选择器是否直接从根节点开始匹配
GKD 的原理是监听系统屏幕节点变化 这时候会接收到一个事件节点, 默认从这个节点开始匹配到其子孙节点
常见情况是: 如果匹配的速度跟不上节点事件数量的产生速度, 下一次匹配的开始节点将变成根节点
但是如果节点事件产生速度较慢, 比如屏幕上只有一个节点(文本)在变化, 那么开始匹配的节点一直将是这个节点
此时如果你的选择器的末端属性选择器选择的不是这个节点, 那么匹配将会失败, 即使你能在网页审查工具查询到这个节点
为了解决这个问题, 你可以设置 matchRoot=true, 这样每次匹配都会从根节点开始匹配
以 快照-16105497 为例, 事件节点总是 _id=8 的节点, 此时如果你的选择器是 `[text*="15秒"] - [text*="跳过"]`
在 matchRoot=false 的情况下, 你的匹配范围如下蓝框
而在 matchRoot=true 的情况下, 你的匹配范围如下蓝框
#### Default 
ts```
false
```

### matchDelay? 
> `optional` **matchDelay** : `Integer`
单位: 毫秒
匹配延迟
规则准备匹配/或被唤醒时, 等待一段时间, 使此规则参与查询屏幕节点

### matchTime? 
> `optional` **matchTime** : `Integer`
单位: 毫秒
规则匹配时间, 此规则参与查询屏幕节点时, 等待一段时间, 休眠此规则
例如某些应用的 开屏广告 的 activityId 容易误触/太广泛, 而开屏广告几乎只在应用切出来时出现, 设置一个有限匹配时间能避免后续的误触

### actionMaximum? 
> `optional` **actionMaximum** : `Integer`
最大执行次数
规则的 action 被执行的最大次数, 达到最大次数时, 休眠此规则
功能类似 matchTime, 适用于只需要执行一次的: 开屏广告/更新弹窗/青少年弹窗 一类规则
当规则准备匹配/或被唤醒时, 将重新计算次数

### resetMatch? 
> `optional` **resetMatch** : `"activity"` | `"match"` | `"app"`
决定如何重置 matchTime/actionMaximum，如果规则因 matchTime/actionMaximum 而休眠, 重置可以唤醒规则
#### Default 
ts```
'activity'
```

#### Examples 
ts```
'activity'
// 当 activity 刷新时, 重置规则
// 刷新 activity 并不代表 activityId 变化
// 如 哔哩哔哩视频播放页 底部点击推荐视频 进入另一个 视频播放页, 进入了新 activity 但是 activityId 并没有变化
```

ts```
'match'
// 在应用内由不匹配界面切换为匹配界面时, 重置规则
```

ts```
'app'
// 重新进入 app 时, 重置规则
```

### actionCdKey? 
> `optional` **actionCdKey** : `Integer`
与这个 key 的 rule 共享 cd
比如开屏广告可能需要多个 rule 去匹配, 当一个 rule 触发时, 其它 rule 的触发是无意义的
如果你对这个 key 的 rule 设置 actionCd=3000, 那么当这个 rule 和 本 rule 触发任意一个时, 在 3000 毫秒 内两个 rule 都将进入 cd

### actionMaximumKey? 
> `optional` **actionMaximumKey** : `Integer`
与这个 key 的 rule 共享次数
比如开屏广告可能需要多个 rule 去匹配, 当一个 rule 触发时, 其它 rule 的触发是无意义的
如果你对这个 key 的 rule 设置 actionMaximum=1, 那么当这个 rule 和 本 rule 触发任意一个时, 两个 rule 都将进入休眠

### order? 
> `optional` **order** : `Integer`
规则参与匹配的顺序, 数字越小越先匹配
如果两个规则 order 相同, 按照 groups 中的数组顺序匹配, app 类型规则顺序优先于 global 类型规则
属于不同订阅的规则按照订阅列表中顺序匹配, 长按订阅卡片可以拖动排序
#### Default 
ts```
0
```

### forcedTime? 
> `optional` **forcedTime** : `Integer`
单位: 毫秒
在开始匹配后的一段时间内, 不管界面没有通知变化, 主动使此规则参与屏幕查询
GKD 借助 onAccessibilityEvent 感知界面变化
但是某些基于 flutter/webview 开发的应用/页面在变化时并不会通知系统去触发 onAccessibilityEvent, 但是屏幕上的节点信息确实产生变化
唯一的办法是在开始匹配的一定时间内主动查询屏幕节点

### priorityTime? 
> `optional` **priorityTime** : `Integer`
设置一个优先级时间, 在优先级时间内, 此规则为 优先级规则
如果规则参与匹配, 匹配顺序为 优先级规则(内部 order 排序) -> 普通规则(内部 order 排序)
当新无障碍事件到来时, 如果当前匹配规则是普通规则, 则中断匹配操作重新匹配
优先时间过后, 规则将变为普通规则
使用场景: 某些应用开启很多规则, 导致开屏一类规则被其他规则阻塞, 可以设置优先级时间让开屏规则优先匹配
注意: 如果全部规则都是优先级规则或只有一个规则, 则不会发生中断行为

### priorityActionMaximum? 
> `optional` **priorityActionMaximum** : `Integer`
优先级执行次数, 触发多少次后, 规则将变为普通规则
#### Default 
ts```
1
```

### snapshotUrls? 
> `optional` **snapshotUrls** : `IArray`<`string`>
当前 规则/规则组 的匹配界面快照链接, 增强订阅可维护性

### excludeSnapshotUrls? 
> `optional` **excludeSnapshotUrls** : `IArray`<`string`>
当前 规则/规则组 的排除匹配界面的快照链接

### exampleUrls? 
> `optional` **exampleUrls** : `IArray`<`string`>
当前 规则/规则组 的规则在手机上的运行示例, 支持 jpg/png/webp/gif
如果规则是多个规则组合起来的, 可以更好看懂规则到底在干啥, 比如 点击关闭按钮-选择关闭原因-确认关闭 这种广告用 gif 看着更清楚在干啥

### key? 
> `optional` **key** : `Integer`
当前规则在列表中的唯一标识
key 没有顺序大小之分, 可以是任意数字
设置后不可更改, 否则造成点击记录错乱

### name? 
> `optional` **name** : `string`
规则名称

```

--------------------------------

### Default Value for matchLauncher

Source: https://gkd.li/api/interfaces/RawGlobalRuleProps

The default value for `matchLauncher` is `false`. This property is used to match the desktop and is only available for global rules.

```typescript
false
```

--------------------------------

### StringMatcher

Source: https://gkd.li/api

Defines a rule for matching strings.

```APIDOC
## Type Alias StringMatcher

### Description
Defines a rule for matching strings.

### Endpoint
N/A (Type alias definition)
```
Tokens:
Raw