@fluxlay/cli 0.1.1 → 0.1.4
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
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# @fluxlay/cli
|
|
2
|
+
|
|
3
|
+
CLI for building, developing, and publishing [Fluxlay](https://fluxlay.com) wallpapers.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g @fluxlay/cli
|
|
9
|
+
# or
|
|
10
|
+
pnpm add -g @fluxlay/cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Commands
|
|
14
|
+
|
|
15
|
+
### `fluxlay login`
|
|
16
|
+
|
|
17
|
+
Authenticate with Fluxlay. Opens a browser window for sign-in and stores the session locally.
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
fluxlay login
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### `fluxlay logout`
|
|
24
|
+
|
|
25
|
+
Remove the stored session.
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
fluxlay logout
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### `fluxlay whoami`
|
|
32
|
+
|
|
33
|
+
Display the currently authenticated user.
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
fluxlay whoami
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### `fluxlay dev [dir]`
|
|
40
|
+
|
|
41
|
+
Start a development server for a wallpaper project. The Fluxlay app will hot-reload as you edit files.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
fluxlay dev
|
|
45
|
+
fluxlay dev ./my-wallpaper
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### `fluxlay build [dir]`
|
|
49
|
+
|
|
50
|
+
Build and package a wallpaper into a `.fluxlay` file.
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
fluxlay build
|
|
54
|
+
fluxlay build ./my-wallpaper -o output.fluxlay
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
| Option | Default | Description |
|
|
58
|
+
|--------|---------|-------------|
|
|
59
|
+
| `-o, --output <name>` | `wallpaper.fluxlay` | Output filename |
|
|
60
|
+
|
|
61
|
+
### `fluxlay publish [dir]`
|
|
62
|
+
|
|
63
|
+
Build and publish a wallpaper to the Fluxlay store.
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
fluxlay publish
|
|
67
|
+
fluxlay publish ./my-wallpaper
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Project Structure
|
|
71
|
+
|
|
72
|
+
A Fluxlay wallpaper project requires a `fluxlay.yaml` manifest at the root:
|
|
73
|
+
|
|
74
|
+
```yaml
|
|
75
|
+
name: My Wallpaper
|
|
76
|
+
slug: my-wallpaper
|
|
77
|
+
version: 0.1.0
|
|
78
|
+
description: |
|
|
79
|
+
A description of your wallpaper.
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Minimal `package.json`
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"name": "my-wallpaper",
|
|
87
|
+
"private": true,
|
|
88
|
+
"version": "0.1.0",
|
|
89
|
+
"type": "module",
|
|
90
|
+
"scripts": {
|
|
91
|
+
"dev": "fluxlay dev",
|
|
92
|
+
"build": "fluxlay build",
|
|
93
|
+
"publish": "fluxlay publish"
|
|
94
|
+
},
|
|
95
|
+
"dependencies": {
|
|
96
|
+
"@fluxlay/sdk": "latest",
|
|
97
|
+
"react": "^19.0.0",
|
|
98
|
+
"react-dom": "^19.0.0"
|
|
99
|
+
},
|
|
100
|
+
"devDependencies": {
|
|
101
|
+
"@fluxlay/cli": "latest",
|
|
102
|
+
"@fluxlay/vite": "latest"
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
```
|