docs: 补充 pake-cli doc

This commit is contained in:
jeasonnow
2023-08-10 18:25:08 +08:00
parent 81f99322b7
commit aace53e513
2 changed files with 86 additions and 0 deletions

40
bin/README.md vendored
View File

@@ -39,6 +39,29 @@ npm install pake-cli -g
## Usage
### Development
The `DEFAULT_DEV_PAKE_OPTIONS` configuration in `bin/defaults.ts` can be modified at development time to match the `pake-cli` configuration description.
```typescript
export const DEFAULT_DEV_PAKE_OPTIONS: PakeCliOptions & {url: string} = {
...DEFAULT_PAKE_OPTIONS,
url: 'https://weread.qq.com',
name: 'Weread',
}
```
then
```bash
yarn cli:dev
```
The script will reads the above configuration and packages the specified `app` using `watch` mode, and changes to the `pake-cli` code and `pake` are hot updated in real time.
### CLI Usage
```bash
pake [url] [options]
```
@@ -180,6 +203,23 @@ Enable recursive copying. When the URL is a local file path, enabling this optio
--iter-copy-file
```
#### [inject]
Using `inject`, you can inject local absolute and relative path `css` and `js` files into the page you specify the `url` to customize it. For example, an adblock script that can be applied to any web page, or a `css` that optimizes the `UI` of a page, you can write it once to customize it. would only need to write the `app` once to generalize it to any other page.
```shell
--inject ./tools/style.css,./tools/hotkey.js
```
#### [safe-domain]
This secure domain is a domain other than your currently configured `url` to which you may be redirected or jumped to, and only in domains that have been configured as secure can you use `tauri` to expose `api` to browsers to ensure that pake's built-in enhancements work correctly. Only in a domain that has been configured as secure can you use the `tauri` to expose the `api` to the browser, ensuring that `pake's` built-in enhancements work correctly.
PS: Secure domains do not need to carry protocols.
```shell
--safe-domain weread.qq.com,google.com
```
## Conclusion
After completing the above steps, your application should be successfully packaged. Please note that the packaging process may take some time depending on your system configuration and network conditions. Be patient, and once the packaging is complete, you can find the application installer in the specified directory.