| () | () |
<!DOCTYPE html> <html lang="en">
<head> <meta charset="UTF-8"> <meta
http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,
initial-scale=1.0"> <meta name="generator"
content="Asciidoctor 2.0.26"> <meta name="author"
content="KeePassXC Team">
<title>keepassxc-cli(1)</title> <link
rel="stylesheet"
href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style> /*! Asciidoctor default stylesheet | MIT License |
https://asciidoctor.org */ /* Uncomment the following line when using as a
custom stylesheet */ /* @import
"https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";
*/ html{font-family:sans-serif;-webkit-text-size-adjust:100%}
a{background:none} a:focus{outline:thin dotted} a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0} b,strong{font-weight:bold}
abbr{font-size:.9em} abbr[title]{cursor:help;border-bottom:1px dotted
#dddddf;text-decoration:none} dfn{font-style:italic} hr{height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap} q{quotes:"201C" "201D"
"2018" "2019"} small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em} sub{bottom:-.25em} img{border:0}
svg:not(:root){overflow:hidden} figure{margin:0}
audio,video{display:inline-block} audio:not([controls]){display:none;height:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal} button,select{text-transform:none}
button,html
input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type=checkbox],input[type=radio]{padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,::before,::after{box-sizing:border-box} html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto
Serif","DejaVu
Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer} img,object,embed{max-width:100%;height:auto}
object,embed{height:100%} img{-ms-interpolation-mode:bicubic}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px} select{width:100%}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f} a img{border:0}
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} p
aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open
Sans","DejaVu
Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title
small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em} h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em} h6{font-size:1em} hr{border:solid
#dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit} code{font-family:"Droid Sans
Mono","DejaVu Sans
Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em} ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
ul.circle{list-style-type:circle} ul.disc{list-style-type:disc}
ul.square{list-style-type:square} ul.circle ul:not([class]),ul.disc
ul:not([class]),ul.square ul:not([class]){list-style:inherit} ol li ul,ol li
ol{margin-left:1.25em;margin-bottom:0} dl
dt{margin-bottom:.3125em;font-weight:bold} dl dd{margin-bottom:1.25em}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px
solid #ddd} blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and
(min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em} h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}} table{background:#fff;margin-bottom:1.25em;border:1px
solid #dedede;word-wrap:normal} table thead,table tfoot{background:#f7f8f7}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr
td{padding:.5em .625em
.625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} table tr
th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt{background:#f8f8f7} table thead tr th,table tfoot
tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle
strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6
strong{font-weight:400} :not(pre).nobreak{word-wrap:normal}
:not(pre).nowrap{white-space:nowrap} :not(pre).pre-wrap{white-space:pre-wrap}
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em
.5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu
Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed} pre
code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal} em
em{font-style:normal} strong strong{font-weight:400}
kbd{font-family:"Droid Sans Mono","DejaVu Sans
Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px
solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0
.1em #fff;margin:0 .15em;padding:.2em
.5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px} p
a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin:0
auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:"
";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em} #content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
#header .details{border-bottom:1px solid
#dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row
wrap} #header .details span:first-child{margin-left:-.125em} #header .details
span.email a{color:rgba(0,0,0,.85)} #header .details br{display:none} #header
.details br+span::before{content:" 0a02013 0a0"}
#header .details
br+span.author::before{content:" 0a022c5 0a0";color:rgba(0,0,0,.85)}
#header .details
br+span#revremark::before{content:" 0a0| 0a0"} #header
#revnumber{text-transform:capitalize} #header
#revnumber::after{content:" 0a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px
solid
#dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em} #toc
ul.sectlevel0>li>a{font-style:italic} #toc ul.sectlevel0
ul.sectlevel1{margin:.5em 0} #toc ul{font-family:"Open
Sans","DejaVu Sans",sans-serif;list-style-type:none} #toc
li{line-height:1.3334;margin-top:.3334em} #toc a{text-decoration:none} #toc
a:active{text-decoration:underline} #toctitle{color:#7a2518;font-size:1.2em}
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0} body.toc2
#header>h1:nth-last-child(2){border-bottom:1px solid
#dddddf;padding-bottom:8px}
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px
solid
#e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em
1em;height:100%;overflow:auto} #toc.toc2
#toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0} #toc.toc2 ul
ul{margin-left:0;padding-left:1em} #toc.toc2 ul.sectlevel0
ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em} body.toc2.toc-right
#toc.toc2{border-right-width:0;border-left:1px solid
#e7e7e9;left:auto;right:0}} @media screen and
(min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em} #toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em} #toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}} #content
#toc{border:1px solid
#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
#content #toc>:first-child{margin-top:0} #content
#toc>:last-child{margin-bottom:0}
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
#content{margin-bottom:.625em} @media screen and
(min-width:768px){#content{margin-bottom:1.25em} #content
h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content
h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:" 0A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content
h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content
h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content
h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
details{margin-left:1.25rem}
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
details>summary::-webkit-details-marker{display:none}
details>summary::before{content:"";border:solid
transparent;border-left:solid;border-width:.3em 0 .3em
.5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
details[open]>summary::before{border:solid
transparent;border-top:solid;border-width:.5em .3em
0;transform:translateY(15%)}
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
@media screen and (min-width:768px){.literalblock
pre,.listingblock>.content>pre{font-size:.90625em}} @media screen and
(min-width:1280px){.literalblock
pre,.listingblock>.content>pre{font-size:1em}} pre.prettyprint
.linenums{line-height:1.45;margin-left:2em} pre.prettyprint
li{background:none;list-style-type:inherit;padding-left:0} pre.prettyprint li
code[data-lang]::before{opacity:1} pre.prettyprint li:not(:first-child)
code[data-lang]::before{display:none}
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.linenotable
td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
table.linenotable td.code{padding-left:.75em} table.linenotable
td.linenos,pre.pygments .linenos{border-right:1px
solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
p.tableblock:last-child{margin-bottom:0}
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all>*>tr>*{border-width:1px}
table.grid-cols>*>tr>*{border-width:0 1px}
table.grid-rows>*>tr>*{border-width:1px 0}
table.frame-all{border-width:1px} table.frame-ends{border-width:1px 0}
table.frame-sides{border-width:0 1px}
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle} table thead th,table
tfoot th{font-weight:bold} tbody tr th{background:#f7f8f7} tbody tr th,tbody
tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em} ol{margin-left:1.75em} ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em} dl dd:last-child,dl
dd:last-child>:last-child{margin-bottom:0} li p,ul dd,ol dd,.olist
.olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
ul.unstyled,ol.unstyled{margin-left:0}
li>p:empty:only-child::before{content:"";display:inline-block}
ul.checklist>li>p:first-child{margin-left:-1em}
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em
-1.25em} ul.inline>li{margin-left:1.25em}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
td.hdlist2{word-wrap:anywhere}
a.image{text-decoration:none;display:inline-block} a.image
object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none} sup.footnote
a:active,sup.footnoteref a:active,#footnotes .footnote
a:first-of-type:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0
.75em;border-width:1px 0 0} #footnotes .footnote{padding:0 .375em 0
.225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
#footnotes .footnote
a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
#footnotes .footnote:last-of-type{margin-bottom:0} #content
#footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
div.unbreakable{page-break-inside:avoid} span.icon>.fa{cursor:default} a
span.icon>.fa{cursor:inherit} pre
.conum[data-value]{position:relative;top:-.125em} b.conum
*{color:inherit!important}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em} p strong,td.content
strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
p{margin-bottom:1.25rem} @page{margin:1.25cm .75cm} @media
print{*{box-shadow:none!important;text-shadow:none!important}
html{font-size:80%}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"("
attr(href)
")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]{border-bottom:1px dotted} abbr[title]::after{content:"
(" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group} svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#header,#content,#footnotes,#footer{max-width:none}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
body.book #header{text-align:center} body.book
#header>h1:first-child{border:0!important;margin:2.5em 0 1em} body.book
#header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important} body.book
#header .details br{display:block} body.book #header .details
br+span::before{content:none!important} body.book
#toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book
.sect1>h2{page-break-before:always} #footer{padding:0 .9375em} @media
amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
#footer{background:none} #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} </style>
</head> <body class="manpage"> <div
id="header"> <h1>keepassxc-cli(1) Manual Page</h1>
<h2 id="_name">NAME</h2> <div
class="sectionbody"> <p>keepassxc-cli - command line
interface for the ChiPass password manager</p> </div> </div>
<div id="content"> <div class="sect1"> <h2
id="_synopsis">SYNOPSIS</h2> <div
class="sectionbody"> <div class="paragraph">
<p><strong>keepassxc-cli</strong>
<em>command</em> [<em>options</em>]</p>
</div> </div> </div> <div class="sect1">
<h2 id="_description">DESCRIPTION</h2> <div
class="sectionbody"> <div class="paragraph">
<p><strong>keepassxc-cli</strong> is the command line
interface for the <strong>ChiPass</strong> password manager. It
provides the ability to query and modify the entries of a KeePass database,
directly from the command line.</p> </div> </div>
</div> <div class="sect1"> <h2
id="_commands">COMMANDS</h2> <div
class="sectionbody"> <div class="dlist">
<dl> <dt
class="hdlist1"><strong>add</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>></dt> <dd> <p>Adds
a new entry to a database. A password can be generated
(<strong>-g</strong> option), or a prompt can be displayed to
input the password (<strong>-p</strong> option). The same password
generation options as documented for the generate command can be used when the
<strong>-g</strong> option is set.</p> </dd> <dt
class="hdlist1"><strong>analyze</strong>
[<em>options</em>]
<<em>database</em>></dt> <dd>
<p>Analyzes passwords in a database for weaknesses using offline HIBP
SHA-1 hash lookup.</p> </dd> <dt
class="hdlist1"><strong>attachment-export</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>>
<<em>attachment_name</em>>
<<em>export_file</em>></dt> <dd>
<p>Exports the content of an attachment to a specified file. Use
<strong>--stdout</strong> option to instead output the contents of
the attachment to stdout.</p> </dd> <dt
class="hdlist1"><strong>attachment-import</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>>
<<em>attachment_name</em>>
<<em>import_file</em>></dt> <dd>
<p>Imports the attachment into an entry. An existing attachment with the
same name may be overwritten if the <strong>-f</strong> option is
specified.</p> </dd> <dt
class="hdlist1"><strong>attachment-rm</strong>
<<em>database</em>>
<<em>entry</em>>
<<em>attachment_name</em>></dt> <dd>
<p>Removes the named attachment from an entry.</p> </dd>
<dt class="hdlist1"><strong>clip</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>>
[<em>timeout</em>]</dt> <dd> <p>Copies an
attribute or the current TOTP (if the <strong>-t</strong> option
is specified) of a database entry to the clipboard. If no attribute name is
specified using the <strong>-a</strong> option, the password is
copied. If multiple entries with the same name exist in different groups, only
the attribute for the first one is copied. For copying the attribute of an
entry in a specific group, the group path to the entry should be specified as
well, instead of just the name. Optionally, a timeout in seconds can be
specified to automatically clear the clipboard, the default timeout is 10
seconds, set to 0 to disable.</p> </dd> <dt
class="hdlist1"><strong>close</strong></dt>
<dd> <p>In interactive mode, closes the currently opened database
(see <strong>open</strong>).</p> </dd> <dt
class="hdlist1"><strong>db-create</strong>
[<em>options</em>]
<<em>database</em>></dt> <dd>
<p>Creates a new database with a password and/or a key file. The key
file will be created if the file that is referred to does not exist. If both
the key file and password are empty, no database will be created.</p>
</dd> <dt
class="hdlist1"><strong>db-edit</strong>
[<em>options</em>]
<<em>database</em>></dt> <dd>
<p>Edits a database. When setting a key file, the key file will be
created if the file that is referred to does not exist.</p> </dd>
<dt class="hdlist1"><strong>db-info</strong>
[<em>options</em>]
<<em>database</em>></dt> <dd>
<p>Show a database’s information.</p> </dd> <dt
class="hdlist1"><strong>diceware</strong>
[<em>options</em>]</dt> <dd> <p>Generates a
random diceware passphrase.</p> </dd> <dt
class="hdlist1"><strong>edit</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>></dt> <dd>
<p>Edits a database entry. A password can be generated
(<strong>-g</strong> option), or a prompt can be displayed to
input the password (<strong>-p</strong> option). The same password
generation options as documented for the generate command can be used when the
<strong>-g</strong> option is set.</p> </dd> <dt
class="hdlist1"><strong>estimate</strong>
[<em>options</em>] [<em>password</em>]</dt>
<dd> <p>Estimates the entropy of a password. The password to
estimate can be provided as a positional argument, or using the standard
input.</p> </dd> <dt
class="hdlist1"><strong>exit</strong></dt>
<dd> <p>Exits interactive mode. Synonymous with
<strong>quit</strong>.</p> </dd> <dt
class="hdlist1"><strong>export</strong>
[<em>options</em>]
<<em>database</em>></dt> <dd>
<p>Exports the content of a database to standard output in the specified
format (defaults to XML).</p> </dd> <dt
class="hdlist1"><strong>generate</strong>
[<em>options</em>]</dt> <dd> <p>Generates a
random password.</p> </dd> <dt
class="hdlist1"><strong>help</strong>
[<em>command</em>]</dt> <dd> <p>Displays a list
of available commands, or detailed information about the specified
command.</p> </dd> <dt
class="hdlist1"><strong>import</strong>
[<em>options</em>] <<em>xml</em>>
<<em>database</em>></dt> <dd>
<p>Imports the contents of an XML exported database to a new created
database with a password and/or key file. The key file will be created if the
file that is referred to does not exist. If both the key file and password are
empty, no database will be created. The new database will be in kdbx 4
format.</p> </dd> <dt
class="hdlist1"><strong>ls</strong>
[<em>options</em>] <<em>database</em>>
[<em>group</em>]</dt> <dd> <p>Lists the contents
of a group in a database. If no group is specified, it will default to the
root group.</p> </dd> <dt
class="hdlist1"><strong>merge</strong>
[<em>options</em>] <<em>database1</em>>
<<em>database2</em>></dt> <dd>
<p>Merges two databases together. The first database file is going to be
replaced by the result of the merge, for that reason it is advisable to keep a
backup of the two database files before attempting a merge. In the case that
both databases make use of the same credentials, the
<strong>--same-credentials</strong> or
<strong>-s</strong> option can be used.</p> </dd>
<dt class="hdlist1"><strong>mkdir</strong>
[<em>options</em>] <<em>database</em>>
<<em>group</em>></dt> <dd> <p>Adds
a new group to a database.</p> </dd> <dt
class="hdlist1"><strong>mv</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>>
<<em>group</em>></dt> <dd>
<p>Moves an entry to a new group.</p> </dd> <dt
class="hdlist1"><strong>open</strong>
[<em>options</em>]
<<em>database</em>></dt> <dd>
<p>Opens the given database in a shell-style interactive mode. This is
useful for performing multiple operations on a single database (e.g.
<strong>ls</strong> followed by
<strong>show</strong>).</p> </dd> <dt
class="hdlist1"><strong>quit</strong></dt>
<dd> <p>Exits interactive mode. Synonymous with
<strong>exit</strong>.</p> </dd> <dt
class="hdlist1"><strong>rm</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>></dt> <dd>
<p>Removes an entry from a database. If the database has a recycle bin,
the entry will be moved there. If the entry is already in the recycle bin, it
will be removed permanently.</p> </dd> <dt
class="hdlist1"><strong>rmdir</strong>
[<em>options</em>] <<em>database</em>>
<<em>group</em>></dt> <dd>
<p>Removes a group from a database. If the database has a recycle bin,
the group will be moved there. If the group is already in the recycle bin, it
will be removed permanently.</p> </dd> <dt
class="hdlist1"><strong>search</strong>
[<em>options</em>] <<em>database</em>>
<<em>term</em>></dt> <dd>
<p>Searches all entries that match a specific search term in a
database.</p> </dd> <dt
class="hdlist1"><strong>show</strong>
[<em>options</em>] <<em>database</em>>
<<em>entry</em>></dt> <dd>
<p>Shows the title, username, password, URL and notes of a database
entry. Can also show the current TOTP. Regarding the occurrence of multiple
entries with the same name in different groups, everything stated in the
<strong>clip</strong> command section also applies here.</p>
</dd> </dl> </div> </div> </div> <div
class="sect1"> <h2
id="_options">OPTIONS</h2> <div
class="sectionbody"> <div class="sect2"> <h3
id="_general_options">General options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>--debug-info</strong></dt>
<dd> <p>Displays debugging information.</p> </dd>
<dt class="hdlist1"><strong>-k</strong>,
<strong>--key-file</strong>
<<em>path</em>></dt> <dd>
<p>Specifies a path to a key file for unlocking the database. In a merge
operation this option, is used to specify the key file path for the first
database.</p> </dd> <dt
class="hdlist1"><strong>--no-password</strong></dt>
<dd> <p>Deactivates the password key for the database.</p>
</dd> <dt
class="hdlist1"><strong>-y</strong>,
<strong>--yubikey</strong>
<<em>slot[:serial]</em>></dt> <dd>
<p>Specifies a yubikey slot for unlocking the database. In a merge
operation this option is used to specify the YubiKey slot for the first
database.</p> </dd> <dt
class="hdlist1"><strong>-q</strong>,
<strong>--quiet</strong>
<<em>path</em>></dt> <dd>
<p>Silences password prompt and other secondary outputs.</p>
</dd> <dt
class="hdlist1"><strong>-h</strong>,
<strong>--help</strong></dt> <dd> <p>Displays
help information.</p> </dd> <dt
class="hdlist1"><strong>-v</strong>,
<strong>--version</strong></dt> <dd> <p>Displays
the program version.</p> </dd> </dl> </div>
</div> <div class="sect2"> <h3
id="_merge_options">Merge options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-d</strong>,
<strong>--dry-run</strong>
<<em>path</em>></dt> <dd>
<p>Prints the changes detected by the merge operation without making any
changes to the database.</p> </dd> <dt
class="hdlist1"><strong>--key-file-from</strong>
<<em>path</em>></dt> <dd> <p>Sets
the path of the key file for the second database.</p> </dd> <dt
class="hdlist1"><strong>--no-password-from</strong></dt>
<dd> <p>Deactivates password key for the database to merge
from.</p> </dd> <dt
class="hdlist1"><strong>--yubikey-from</strong>
<<em>slot[:serial]</em>></dt> <dd>
<p>YubiKey slot for the second database.</p> </dd> <dt
class="hdlist1"><strong>-s</strong>,
<strong>--same-credentials</strong></dt> <dd>
<p>Uses the same credentials for unlocking both databases.</p>
</dd> </dl> </div> </div> <div
class="sect2"> <h3 id="_add_and_edit_options">Add
and edit options</h3> <div class="paragraph">
<p>The same password generation options as documented for the generate
command can be used with those 2 commands when the
<strong>-g</strong> option is set.</p> </div> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-u</strong>,
<strong>--username</strong>
<<em>username</em>></dt> <dd>
<p>Specifies the username of the entry.</p> </dd> <dt
class="hdlist1"><strong>--url</strong>
<<em>url</em>></dt> <dd>
<p>Specifies the URL of the entry.</p> </dd> <dt
class="hdlist1"><strong>--notes</strong>
<<em>notes</em>></dt> <dd>
<p>Specifies the notes of the entry.</p> </dd> <dt
class="hdlist1"><strong>-p</strong>,
<strong>--password-prompt</strong></dt> <dd>
<p>Uses a password prompt for the entry’s password.</p>
</dd> <dt
class="hdlist1"><strong>-g</strong>,
<strong>--generate</strong></dt> <dd>
<p>Generates a new password for the entry.</p> </dd>
</dl> </div> </div> <div class="sect2">
<h3 id="_edit_options">Edit options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-t</strong>,
<strong>--title</strong>
<<em>title</em>></dt> <dd>
<p>Specifies the title of the entry.</p> </dd> </dl>
</div> </div> <div class="sect2"> <h3
id="_estimate_options">Estimate options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-a</strong>,
<strong>--advanced</strong></dt> <dd>
<p>Performs advanced analysis on the password.</p> </dd>
</dl> </div> </div> <div class="sect2">
<h3 id="_analyze_options">Analyze options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-H</strong>,
<strong>--hibp</strong>
<<em>filename</em>></dt> <dd>
<p>Checks if any passwords have been publicly leaked, by comparing
against the given list of password SHA-1 hashes, which must be in "Have I
Been Pwned" format. Such files are available from <a
href="https://haveibeenpwned.com/Passwords"
class="bare">https://haveibeenpwned.com/Passwords</a>; note
that they are large, and so this operation typically takes some time (minutes
up to an hour or so).</p> </dd> <dt
class="hdlist1"><strong>--okon</strong>
<<em>okon-cli path</em>></dt> <dd>
<p>Use the specified okon-cli program to perform offline breach checks.
You can obtain okon-cli from <a
href="https://github.com/stryku/okon"
class="bare">https://github.com/stryku/okon</a>. When using
this option, <strong>-H, --hibp</strong> must point to a
post-processed okon file (e.g. file.okon).</p> </dd> </dl>
</div> </div> <div class="sect2"> <h3
id="_clip_options">Clip options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-a</strong>,
<strong>--attribute</strong></dt> <dd> <p>Copies
the specified attribute to the clipboard. If no attribute is specified, the
password attribute is the default. For example,
"<strong>-a</strong>
<strong>username</strong>" would copy the username to the
clipboard. [Default: password]</p> </dd> <dt
class="hdlist1"><strong>-t</strong>,
<strong>--totp</strong></dt> <dd> <p>Copies the
current TOTP instead of the specified attribute to the clipboard. Will report
an error if no TOTP is configured for the entry.</p> </dd> <dt
class="hdlist1"><strong>-b</strong>,
<strong>--best</strong></dt> <dd> <p>Try to find
and copy to clipboard a unique entry matching the input If a unique matching
entry is found it will be copied to the clipboard. If multiple entries are
found they will be listed to refine the search. (no clip performed)</p>
</dd> </dl> </div> </div> <div
class="sect2"> <h3
id="_db_create_db_edit_and_import_options">Db-create, Db-edit and
Import options</h3> <div class="dlist"> <dl>
<dt
class="hdlist1"><strong>--set-key-file</strong>
<<em>path</em>></dt> <dd> <p>Set
the key file for the database.</p> </dd> <dt
class="hdlist1"><strong>-p</strong>,
<strong>--set-password</strong></dt> <dd> <p>Set
a password for the database.</p> </dd> </dl> </div>
</div> <div class="sect2"> <h3
id="_db_create_import_options">Db-create, Import
options</h3> <div class="dlist"> <dl> <dt
class="hdlist1"><strong>-t</strong>,
<strong>--decryption-time</strong>
<<em>time</em>></dt> <dd>
<p>Target decryption time in MS for the database.</p> </dd>
</dl> </div> </div> <div class="sect2">
<h3 id="_db_edit_options">Db-edit options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>--unset-password</strong>
<<em>path</em>></dt> <dd>
<p>Removes the password for the database.</p> </dd> <dt
class="hdlist1"><strong>--unset-key-file</strong>
<<em>path</em>></dt> <dd>
<p>Removes the key file for the database.</p> </dd>
</dl> </div> </div> <div class="sect2">
<h3 id="_show_options">Show options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-a</strong>,
<strong>--attributes</strong>
<<em>attribute</em>>…​</dt>
<dd> <p>Shows the named attributes. This option can be specified
more than once, with each attribute shown one-per-line in the given order. If
no attributes are specified and <strong>-t</strong> is not
specified, a summary of the default attributes is given. Protected attributes
will be displayed in clear text if specified explicitly by this
option.</p> </dd> <dt
class="hdlist1"><strong>--all</strong></dt>
<dd> <p>Show all the attributes of the entry.</p>
</dd> <dt
class="hdlist1"><strong>-s</strong>,
<strong>--show-protected</strong></dt> <dd>
<p>Shows the protected attributes in clear text.</p> </dd>
<dt
class="hdlist1"><strong>--show-attachments</strong></dt>
<dd> <p>Shows the attachment names along with the size of the
attachments.</p> </dd> <dt
class="hdlist1"><strong>-t</strong>,
<strong>--totp</strong></dt> <dd> <p>Also shows
the current TOTP, reporting an error if no TOTP is configured for the
entry.</p> </dd> </dl> </div> </div> <div
class="sect2"> <h3
id="_diceware_options">Diceware options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-W</strong>,
<strong>--words</strong>
<<em>count</em>></dt> <dd> <p>Sets
the desired number of words for the generated passphrase. [Default:
7]</p> </dd> <dt
class="hdlist1"><strong>-w</strong>,
<strong>--word-list</strong>
<<em>path</em>></dt> <dd> <p>Sets
the Path of the wordlist for the diceware generator. The wordlist must have
> 1000 words, otherwise the program will fail. If the wordlist has
< 4000 words a warning will be printed to STDERR. Any
<strong>diceware</strong>-compatible wordlist can be used. Note
however that <strong>ChiPass</strong> will NOT verify the PGP
signature of signed wordlists.</p> </dd> </dl> </div>
</div> <div class="sect2"> <h3
id="_export_options">Export options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-f</strong>,
<strong>--format</strong></dt> <dd> <p>Format to
use when exporting. Available choices are xml or csv. Defaults to
xml.</p> </dd> </dl> </div> </div> <div
class="sect2"> <h3 id="_list_options">List
options</h3> <div class="dlist"> <dl> <dt
class="hdlist1"><strong>-R</strong>,
<strong>--recursive</strong></dt> <dd>
<p>Recursively lists the elements of the group.</p> </dd>
<dt class="hdlist1"><strong>-f</strong>,
<strong>--flatten</strong></dt> <dd> <p>Flattens
the output to single lines. When this option is enabled, subgroups and
subentries will be displayed with a relative group path instead of
indentation.</p> </dd> </dl> </div> </div>
<div class="sect2"> <h3
id="_generate_options">Generate options</h3> <div
class="dlist"> <dl> <dt
class="hdlist1"><strong>-L</strong>,
<strong>--length</strong>
<<em>length</em>></dt> <dd>
<p>Sets the desired length for the generated password. [Default:
16]</p> </dd> <dt
class="hdlist1"><strong>-l</strong>,
<strong>--lower</strong></dt> <dd> <p>Uses
lowercase characters for the generated password. [Default: Enabled]</p>
</dd> <dt
class="hdlist1"><strong>-U</strong>,
<strong>--upper</strong></dt> <dd> <p>Uses
uppercase characters for the generated password. [Default: Enabled]</p>
</dd> <dt
class="hdlist1"><strong>-n</strong>,
<strong>--numeric</strong></dt> <dd> <p>Uses
numbers characters for the generated password. [Default: Enabled]</p>
</dd> <dt
class="hdlist1"><strong>-s</strong>,
<strong>--special</strong></dt> <dd> <p>Uses
special characters for the generated password. [Default: Disabled]</p>
</dd> <dt
class="hdlist1"><strong>-e</strong>,
<strong>--extended</strong></dt> <dd> <p>Uses
extended ASCII characters for the generated password. [Default:
Disabled]</p> </dd> <dt
class="hdlist1"><strong>-x</strong>,
<strong>--exclude</strong>
<<em>chars</em>></dt> <dd>
<p>Comma-separated list of characters to exclude from the generated
password. None is excluded by default.</p> </dd> <dt
class="hdlist1"><strong>--exclude-similar</strong></dt>
<dd> <p>Exclude similar looking characters. [Default:
Disabled]</p> </dd> <dt
class="hdlist1"><strong>--every-group</strong></dt>
<dd> <p>Include characters from every selected group. [Default:
Disabled]</p> </dd> </dl> </div> </div>
</div> </div> <div class="sect1"> <h2
id="_notes">NOTES</h2> <div
class="sectionbody"> <div class="dlist">
<dl> <dt class="hdlist1"><strong>Project
homepage</strong></dt> <dd> <p><a
href="https://chipass.org"
class="bare">https://chipass.org</a></p> </dd>
<dt class="hdlist1"><strong>QuickStart
Guide</strong></dt> <dd> <p><a
href="https://codeberg.org/ChiPass/ChiPass/src/branch/main/docs/GettingStarted.adoc"
class="bare">https://codeberg.org/ChiPass/ChiPass/src/branch/main/docs/GettingStarted.adoc</a></p>
</dd> <dt class="hdlist1"><strong>User
Guide</strong></dt> <dd> <p><a
href="https://codeberg.org/ChiPass/ChiPass/src/branch/main/docs/UserGuide.adoc"
class="bare">https://codeberg.org/ChiPass/ChiPass/src/branch/main/docs/UserGuide.adoc</a></p>
</dd> <dt class="hdlist1"><strong>Git
repository</strong></dt> <dd> <p><a
href="https://codeberg.org/ChiPass/ChiPass.git"
class="bare">https://codeberg.org/ChiPass/ChiPass.git</a></p>
</dd> </dl> </div> </div> </div> <div
class="sect1"> <h2 id="_author">AUTHOR</h2>
<div class="sectionbody"> <div
class="paragraph"> <p>This manual page was originally
written by Manolis Agkopian <<a
href="mailto:m.agkopian@gmail.com">m.agkopian@gmail.com</a>>.</p>
</div> </div> </div> <div class="sect1">
<h2 id="_reporting_bugs">REPORTING BUGS</h2> <div
class="sectionbody"> <div class="paragraph">
<p>Bugs and feature requests can be reported on Codeberg at <a
href="https://codeberg.org/ChiPass/ChiPass/issues"
class="bare">https://codeberg.org/ChiPass/ChiPass/issues</a>.</p>
</div> </div> </div> <div class="sect1">
<h2 id="_copyright">COPYRIGHT</h2> <div
class="sectionbody"> <div class="paragraph">
<p>Copyright (C) 2016-2020 KeePassXC Team <<a
href="mailto:team@keepassxc.org">team@keepassxc.org</a>></p>
</div> <div class="paragraph"> <p>This program is
free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License, either version 2 or version 3. There is NO
WARRANTY, to the extent permitted by law.</p> </div> </div>
</div> <div class="sect1"> <h2
id="_see_also">SEE ALSO</h2> <div
class="sectionbody"> <div class="paragraph">
<p><strong>keepassxc</strong>(1)</p> </div>
</div> </div> </div> <div id="footer">
<div id="footer-text"> Version 2026.09.0<br> Last
updated 2026-09-11 19:12:11 UTC </div> </div> </body>
</html>