KEEPASSXC-CLI(1) General Commands Manual KEEPASSXC-CLI(1) نام (NAME) keepassxc-cli - واسط خط فرمان برای نرم‌افزار مدیریت گذرواژه KeePassXC خلاصه دستور (SYNOPSIS) keepassxc-cli command [options] توضیحات (DESCRIPTION) ابزار keepassxc-cli رابط خط فرمان برای مدیر گذرواژهٔ KeePassXC است. این ابزار امکان جست‌وجو، مشاهده و ویرایش مدخل‌های یک پایگاه‌دادهٔ KeePass را به طور مستقیم از طریق خط فرمان فراهم می‌کند. دستورها (COMMANDS) add [options] مدخل جدیدی را به پایگاه‌داده اضافه می‌کند. می‌توان یک گذرواژه ایجاد کرد (با گزینهٔ -g) یا اعلانی برای ورود گذرواژه نمایش داد (با گزینهٔ -p). در صورت فعال بودن گزینهٔ -g، همان گزینه‌های تولید گذرواژه که برای دستور generate مستند شده است، قابل استفاده هستند. analyze [options] گذرواژه‌های موجود در یک پایگاه‌داده را برای یافتن نقاط ضعف با استفاده از جست‌وجوی آفلاین هش‌های HIBP SHA-1 تحلیل می‌کند. attachment-export [options] محتوای یک پیوست را به یک پروندهٔ مشخص صادر می‌کند. برای ارسال محتوای پیوست به خروجی استاندارد (stdout) از گزینهٔ --stdout استفاده کنید. attachment-import [options] پیوست را به یک مدخل وارد می‌کند. در صورتی که گزینهٔ -f مشخص شده باشد، پیوست موجود با همان نام بازنویسی خواهد شد. attachment-rm پیوست نام‌برده را از یک مدخل حذف می‌کند. clip [options] [timeout] یک ویژگی یا TOTP فعلی (در صورت تعیین گزینهٔ -t) از مدخل پایگاه‌داده را در کلیپ‌بورد کپی می‌کند. اگر هیچ نام ویژگی با استفاده از گزینهٔ -a مشخص نشود، گذرواژه کپی می‌شود. اگر چندین مدخل با یک نام در گروه‌های مختلف وجود داشته باشند، فقط ویژگی مربوط به اولین مدخل کپی می‌شود. برای کپی کردن ویژگی یک مدخل در یک گروه خاص، باید مسیر گروهی به مدخل نیز به جای فقط نام مشخص شود. به صورت اختیاری می‌توان یک مهلت زمانی به ثانیه برای پاک کردن خودکار کلیپ‌بورد مشخص کرد؛ مهلت پیش‌فرض ۱۰ ثانیه است و مقدار 0 آن را غیرفعال می‌کند. close در حالت تعاملی، پایگاه‌دادهٔ بازشده فعلی را می‌بندد (به open مراجعه کنید). db-create [options] پایگاه‌دادهٔ جدیدی با گذرواژه و/یا پروندهٔ کلید ایجاد می‌کند. اگر پروندهٔ ارجاع‌شده وجود نداشته باشد، پروندهٔ کلید ایجاد خواهد شد. اگر هر دوی پروندهٔ کلید و گذرواژه خالی باشند، هیچ پایگاه‌داده‌ای ایجاد نخواهد شد. db-edit [options] پایگاه‌داده را ویرایش می‌کند. هنگام تنظیم پروندهٔ کلید، اگر پروندهٔ ارجاع‌شده وجود نداشته باشد، پروندهٔ کلید ساخته خواهد شد. db-info [options] اطلاعات یک پایگاه‌داده را نمایش می‌دهد. diceware [options] یک عبارت عبور تصادفی به روش دایسوِیر (diceware) تولید می‌کند. edit [options] یک مدخل پایگاه‌داده را ویرایش می‌کند. می‌توان یک گذرواژه ایجاد کرد (با گزینهٔ -g) یا اعلانی برای ورود گذرواژه نمایش داد (با گزینهٔ -p). در صورت فعال بودن گزینهٔ -g، همان گزینه‌های تولید گذرواژه که برای دستور generate مستند شده است، قابل استفاده هستند. estimate [options] [password] آنتروپی (میزان تصادفی بودن و استحکام) یک گذرواژه را تخمین می‌زند. گذرواژه مورد ارزیابی را می‌توان به عنوان آرگومان موقعیتی یا از طریق ورودی استاندارد فراهم کرد. exit خروج از حالت تعاملی. مترادف با quit. export [options] محتوای یک پایگاه‌داده را در قالب مشخص‌شده (پیش‌فرض XML) به خروجی استاندارد صادر می‌کند. generate [options] یک گذرواژهٔ تصادفی تولید می‌کند. help [command] فهرستی از دستورهای موجود یا اطلاعات دقیق دربارهٔ دستور مشخص‌شده را نمایش می‌دهد. import [options] محتوای یک پایگاه‌دادهٔ صادرشده به قالب XML را به یک پایگاه‌دادهٔ تازه‌ساخته‌شده همراه با گذرواژه و/یا پروندهٔ کلید وارد می‌کند. اگر پروندهٔ ارجاع‌شده وجود نداشته باشد، پروندهٔ کلید ایجاد خواهد شد. اگر هر دوی پروندهٔ کلید و گذرواژه خالی باشند، هیچ پایگاه‌داده‌ای ایجاد نخواهد شد. پایگاه‌دادهٔ جدید در قالب kdbx 4 خواهد بود. ls [options] [group] محتویات یک گروه در پایگاه‌داده را فهرست می‌کند. اگر هیچ گروهی مشخص نشود، به طور پیش‌فرض گروه ریشه (root) فهرست خواهد شد. merge [options] دو پایگاه‌داده را در یکدیگر ادغام می‌کند. پروندهٔ پایگاه‌دادهٔ اول با نتیجهٔ ادغام جایگزین خواهد شد؛ به همین دلیل توصیه می‌شود پیش از اقدام به ادغام، نسخهٔ پشتیبان از هر دو پروندهٔ پایگاه‌داده نگهداری کنید. در صورتی که هر دو پایگاه‌داده از اعتبارنامه‌های یکسان استفاده می‌کنند، گزینهٔ --same-credentials یا -s قابل استفاده است. mkdir [options] یک گروه جدید به پایگاه‌داده اضافه می‌کند. mv [options] یک مدخل را به گروه جدیدی منتقل می‌کند. open [options] پایگاه‌دادهٔ داده‌شده را در حالت تعاملیِ پوسته‌مانند باز می‌کند. این کار برای انجام چندین عملیات روی یک پایگاه‌داده مفید است (مانند ls و به دنبال آن show). quit خروج از حالت تعاملی. مترادف با exit. rm [options] یک مدخل را از پایگاه‌داده حذف می‌کند. اگر پایگاه‌داده دارای سطل بازیافت باشد، مدخل به آن‌جا منتقل خواهد شد. اگر مدخل از قبل در سطل بازیافت باشد، برای همیشه حذف خواهد شد. rmdir [options] یک گروه را از پایگاه‌داده حذف می‌کند. اگر پایگاه‌داده دارای سطل بازیافت باشد، گروه به آن‌جا منتقل خواهد شد. اگر گروه از قبل در سطل بازیافت باشد، برای همیشه حذف خواهد شد. search [options] تمام مدخل‌هایی را که با یک عبارت جست‌وجوی خاص در پایگاه‌داده تطابق دارند جست‌وجو می‌کند. show [options] عنوان، نام کاربری، گذرواژه، نشانی URL و یادداشت‌های یک مدخل پایگاه‌داده را نمایش می‌دهد. همچنین می‌تواند TOTP فعلی را نشان دهد. در مورد وجود چندین مدخل با نام یکسان در گروه‌های مختلف، تمام موارد ذکرشده در بخش دستور clip در این‌جا نیز صدق می‌کند. گزینه‌ها (OPTIONS) گزینه‌های عمومی (General options) --debug-info نمایش اطلاعات اشکال‌زدایی (دیباگ). -k, --key-file مشخص کردن مسیر پروندهٔ کلید برای باز کردن قفل پایگاه‌داده. در یک عملیات ادغام، این گزینه برای مشخص کردن مسیر پروندهٔ کلید برای پایگاه‌داده اول استفاده می‌شود. --no-password غیرفعال کردن کلید گذرواژه برای پایگاه‌داده. -y, --yubikey مشخص کردن اسلات YubiKey برای باز کردن قفل پایگاه‌داده. در یک عملیات ادغام، این گزینه برای مشخص کردن اسلات YubiKey برای پایگاه‌داده اول استفاده می‌شود. -q, --quiet بی‌صدا کردن اعلان گذرواژه و سایر خروجی‌های ثانویه. -h, --help نمایش اطلاعات راهنما. -v, --version نمایش نسخهٔ برنامه. گزینه‌های ادغام (Merge options) -d, --dry-run تغییرات شناسایی‌شده توسط عملیات ادغام را بدون اعمال هیچ تغییری در پایگاه‌داده چاپ می‌کند. --key-file-from تنظیم مسیر پروندهٔ کلید برای پایگاه‌داده دوم. --no-password-from غیرفعال کردن کلید گذرواژه برای پایگاه‌داده‌ای که از آن ادغام انجام می‌شود. --yubikey-from اسلات YubiKey برای پایگاه‌داده دوم. -s, --same-credentials استفاده از اعتبارنامه‌های یکسان برای باز کردن قفل هر دو پایگاه‌داده. گزینه‌های افزودن و ویرایش (Add and edit options) در صورت تنظیم گزینهٔ -g، همان گزینه‌های تولید گذرواژه که برای دستور generate مستند شده است را می‌توان با این ۲ دستور استفاده کرد. -u, --username مشخص کردن نام کاربری مدخل. --url مشخص کردن نشانی URL مدخل. --notes مشخص کردن یادداشت‌های مدخل. -p, --password-prompt استفاده از اعلان ورودی برای گذرواژهٔ مدخل. -g, --generate تولید یک گذرواژهٔ جدید برای مدخل. گزینه‌های ویرایش (Edit options) -t, --title مشخص کردن عنوان مدخل. گزینه‌های تخمین (Estimate options) -a, --advanced انجام تحلیل پیشرفته روی گذرواژه. گزینه‌های تحلیل (Analyze options) -H, --hibp <filename> بررسی می‌کند که آیا گذرواژه‌ای به صورت عمومی فاش شده است یا خیر، با مقایسه در برابر فهرست ارائه‌شده از هش‌های SHA-1 گذرواژه‌ها، که باید در قالب "Have I Been Pwned" باشند. چنین پرونده‌هایی از طریق نشانی زیر در دسترس هستند: <https://haveibeenpwned.com/Passwords>; توجه داشته باشید که این پرونده‌ها بسیار حجیم هستند و بنابراین این عملیات معمولاً مدتی زمان می‌برد (از چند دقیقه تا حدود یک ساعت). --okon <okon-cli path> استفاده از برنامهٔ okon-cli مشخص‌شده برای بررسی آفلاین رخنه‌ها. می‌توانید okon-cli را از نشانی زیر دریافت کنید: <https://github.com/stryku/okon>. هنگام استفاده از این گزینه، -H, --hibp باید به یک پروندهٔ پردازش‌شدهٔ okon (مانند file.okon) اشاره کند. گزینه‌های کلیپ‌بورد (Clip options) -a, --attribute کپی کردن ویژگی مشخص‌شده در کلیپ‌بورد. اگر هیچ ویژگی‌ای مشخص نشود، ویژگی گذرواژه (password) پیش‌فرض است. برای نمونه، "-a username" نام کاربری را در کلیپ‌بورد کپی می‌کند. [پیش‌فرض: password] -t, --totp کپی کردن TOTP فعلی به جای ویژگی مشخص‌شده در کلیپ‌بورد. در صورتی که هیچ TOTPای برای مدخل پیکربندی نشده باشد، خطا گزارش می‌شود. -b, --best تلاش برای یافتن و کپی کردن یک مدخل منحصر‌به‌فرد منطبق بر ورودی در کلیپ‌بورد. اگر یک مدخل منطبق منحصربه‌فرد پیدا شود در کلیپ‌بورد کپی خواهد شد. در صورت یافتن چندین مدخل، آن‌ها برای پالایش جست‌وجو فهرست می‌شوند (هیچ کپی در کلیپ‌بورد انجام نمی‌شود). گزینه‌های ایجاد، ویرایش و وارد کردن پایگاه‌داده (Db-create, Db-edit and Import options) --set-key-file <path> تنظیم پروندهٔ کلید برای پایگاه‌داده. -p, --set-password تنظیم یک گذرواژه برای پایگاه‌داده. گزینه‌های ایجاد و وارد کردن پایگاه‌داده (Db-create, Import options) -t, --decryption-time <time> زمان هدف برای رمزگشایی پایگاه‌داده بر حسب میلی‌ثانیه. گزینه‌های ویرایش پایگاه‌داده (Db-edit options) --unset-password <path> حذف گذرواژه برای پایگاه‌داده. --unset-key-file <path> حذف پروندهٔ کلید برای پایگاه‌داده. گزینه‌های نمایش (Show options) -a, --attributes <attribute>... نمایش ویژگی‌های نام‌برده. این گزینه می‌تواند بیش از یک بار مشخص شود و هر ویژگی به ترتیب در یک خط جداگانه نشان داده می‌شود. اگر هیچ ویژگی‌ای مشخص نشود و -t تعیین نشده باشد، خلاصه‌ای از ویژگی‌های پیش‌فرض ارائه می‌شود. ویژگی‌های محافظت‌شده در صورتی که به صراحت با این گزینه مشخص شوند، به صورت متن آشکار نمایش داده خواهند شد. --all نمایش تمام ویژگی‌های مدخل. -s, --show-protected نمایش ویژگی‌های محافظت‌شده به صورت متن آشکار. --show-attachments نمایش نام پیوست‌ها به همراه اندازهٔ پیوست‌ها. -t, --totp همچنین TOTP فعلی را نشان می‌دهد؛ در صورتی که هیچ TOTPای برای مدخل پیکربندی نشده باشد، خطا گزارش می‌دهد. گزینه‌های دایسوِیر (Diceware options) -W, --words <count> تنظیم تعداد واژه‌های مورد نظر برای عبارت عبور تولیدشده. [پیش‌فرض: 7] -w, --word-list <path> تنظیم مسیر فهرست واژگان برای مولد دایسوِیر. فهرست واژگان باید بیش از ۱۰۰۰ واژه داشته باشد، در غیر این صورت برنامه با شکست مواجه می‌شود. اگر فهرست واژگان کمتر از ۴۰۰۰ واژه داشته باشد، هشداری در STDERR چاپ می‌شود. هر فهرست واژگان سازگار با diceware قابل استفاده است. البته توجه داشته باشید که KeePassXC امضای PGP فهرست‌های واژگان امضاشده را اعتبارسنجی نخواهد کرد. گزینه‌های صدور (Export options) -f, --format قالب مورد استفاده هنگام صدور خروجی. گزینه‌های موجود xml یا csv هستند. پیش‌فرض xml است. گزینه‌های فهرست‌بندی (List options) -R, --recursive فهرست‌بندی بازگشتی عناصر گروه. -f, --flatten تخت کردن خروجی به صورت تک‌خطی. در صورت فعال بودن این گزینه، زیرگروه‌ها و زیرمدخل‌ها به جای دندانه‌گذاری با مسیر گروهی نسبی نمایش داده می‌شوند. گزینه‌های تولید گذرواژه (Generate options) -L, --length <length> تنظیم طول مورد نظر برای گذرواژهٔ تولیدشده. [پیش‌فرض: 16] -l, --lower استفاده از نویسه‌های کوچک برای گذرواژهٔ تولیدشده. [پیش‌فرض: فعال] -U, --upper استفاده از نویسه‌های بزرگ برای گذرواژهٔ تولیدشده. [پیش‌فرض: فعال] -n, --numeric استفاده از نویسه‌های عددی برای گذرواژهٔ تولیدشده. [پیش‌فرض: فعال] -s, --special استفاده از نویسه‌های ویژه برای گذرواژهٔ تولیدشده. [پیش‌فرض: غیرفعال] -e, --extended استفاده از نویسه‌های اَسکی گسترش‌یافته (extended ASCII) برای گذرواژهٔ تولیدشده. [پیش‌فرض: غیرفعال] -x, --exclude <chars> فهرستی از نویسه‌های جداشده با کاما برای مستثنی کردن از گذرواژهٔ تولیدشده. به صورت پیش‌فرض هیچ نویسه‌ای مستثنی نیست. --exclude-similar مستثنی کردن نویسه‌های مشابه با یکدیگر از نظر ظاهری. [پیش‌فرض: غیرفعال] --every-group گنجاندن نویسه‌ها از هر یک از گروه‌های انتخاب‌شده. [پیش‌فرض: غیرفعال] نکات (NOTES) صفحه اصلی پروژه <https://keepassxc.org> راهنمای شروع سریع <https://keepassxc.org/docs/KeePassXC_GettingStarted.html> راهنمای کاربر <https://keepassxc.org/docs/KeePassXC_UserGuide.html> مخزن گیت <https://github.com/keepassxreboot/keepassxc.git> نویسنده (AUTHOR) این صفحهٔ راهنما در ابتدا توسط Manolis Agkopian <m.agkopian@gmail.com>. نوشته شده است. گزارش باگ‌ها (REPORTING BUGS) گزارش اشکالات و درخواست امکانات جدید را می‌توان در گیت‌هاب در نشانی زیر ثبت کرد: <https://github.com/keepassxreboot/keepassxc/issues>. حق نشر (COPYRIGHT) حق نشر (C) 2016-2020 تیم KeePassXC <team@keepassxc.org> این برنامه نرم‌افزار آزاد است: شما می‌توانید آن را تحت شرایط مجوز عمومی همگانی گنو (GNU General Public License) نسخهٔ ۲ یا نسخهٔ ۳ بازتوزیع کرده و/یا تغییر دهید. هیچ ضمانتی برای این نرم‌افزار وجود ندارد، تا حدی که توسط قانون مجاز دانسته شده است. همچنین ببینید (SEE ALSO) keepassxc(1) نویسنده (AUTHOR) تیم KeePassXC KeePassXC 2.7.12 2022-08-20 KEEPASSXC-CLI(1)