UNPKG

pocketbase-import

Version:

A CLI tool for importing CSV data into PocketBase collections with authentication support.

github.com/3n3a/pocketbase-import

3n3a/pocketbase-import

67 lines (45 loc) • 1.96 kB
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
65
66
67
# PocketBase CSV Importer A command-line tool to import CSV data into a specified collection in a PocketBase instance. ## Features - Authenticate with PocketBase using admin credentials - Read CSV files and import records into a specified collection - Supports environment variables for configuration - Handles errors and logs progress during import ## Installation Ensure you have Node.js installed, then install the package globally: ```sh npm install -g pocketbase-import ``` ## Usage ```sh pocketbase-import -c <collection> -f <file> --url <pocketbase_url> -u <username> -p <password> ``` ### Required Options: - `-c, --collection <string>`: The name of the PocketBase collection to import into. - `-f, --file <string>`: The path to the CSV file to import. ### Optional Environment Variables: Instead of passing credentials via command line arguments, you can use environment variables: - `PB_URL`: PocketBase instance URL (including port if necessary) - `PB_USER`: PocketBase admin username - `PB_PASS`: PocketBase admin password Example using environment variables: ```sh PB_URL="http://127.0.0.1:8090" PB_USER="admin@example.com" PB_PASS="securepassword" pocketbase-import -c users -f data.csv ``` ## Example ```sh pocketbase-import -c users -f users.csv --url http://127.0.0.1:8090 -u admin@example.com -p mypassword ``` ## Error Handling - If authentication fails, the script will exit with an error. - If the CSV file is not found or cannot be read, an error message is displayed. - If the specified collection does not exist, the script will terminate. - Any failed record imports will be logged with the error message. ## Debug Mode Enable debugging by setting `DEBUG=true` in the script or modifying the `DEBUG` constant in the source code. ## License MIT License ## Contributions Feel free to open an issue or submit a pull request if you find any bugs or want to add features! --- Made with ❤️ for the PocketBase community.