aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 84322f3b32f6ba6906e49f7800443aacd8d55df3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# Dashlane CLI Git AUR package

This project provides a command-line interface (CLI) for Dashlane, built with the local Node.js version installed. It is the GitHub version of the Dashlane CLI.

## Getting Started

These instructions will get you a copy of the package up and running on your local machine for development and testing purposes.

### Prerequisites

All tools required are installed on package installation.

> Note: Your shell config will be configured if you haven't set up asdf yet.

### Installation

Install the package using the `just` command:

```zsh
just install
```

## Usage

You can use the `just _<task-name>_` command to perform various tasks:

- `just build`: Build the package.
- `just rebuild`: Rebuild the package.
- `just install`: Install the package.
- `just uninstall`: Uninstall the package.
- `just test`: Test the package installation.
- `just publish`: Publish the package.
- `just push:` Push to the AUR remote.
- `just dcli-bundle-version`: Check the version of the Dashlane CLI bundle.
- `just dcli-bundle-sync`: Sync the Dashlane CLI bundle.
- `just test-local`: Test the local build.
- `just test`: Test the package installation.
- `just clean`: Clean the Git repository.
- `just clean-force`: Force clean the Git repository.
- `just set-remote-master-to-aur-branch`: Set the remote master branch to the AUR branch.
- `just remote-add-aur`: Add the AUR remote.
- `just clone-empty-aur`: Clone the empty AUR repository.


Use only the `just` command to see the list of available tasks:

```zsh
just
```

## Contributing

Contributions are welcome.

## Versioning

The versions are mirrored from the [Dashlane CLI repository](https://github.com/Dashlane/dashlane-cli.git)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

[Dashlane CLI repository](https://github.com/Dashlane/dashlane-cli.git) provides its own license.