Install the complete package with local command reference and every published mode.
install confconf.conf, .cfg and .env files made of key/value pairs and sections. Writes are atomic, and dump returns a normalized configuration.
database.host means the host key inside the database section. Read or search first, then change only the required path with -w; use
conf <file> [key|options] · conf dump <file>conf <file>show configuration data
conf <file> <key>show one exact path or value
conf dump <file>show normalized source text
-f <text|mask> [-k|-v]find matching keys, paths or values
-w <key> : <value>write a value directly to the file
-w <key> < <file>write a value read from another file
-d <key>delete a value or path
-cvalidate the file
With the current core, a successfully opened file is immediately available as $. If this module is the highest-priority installed handler for the file extension, typing the filename by itself opens it through this command. These are core conveniences;
-f searches paths and values. Add -k for keys only or -v for values only. Queries containing * or ? are treated as masks.
-w writes immediately to the file. Use : for an inline value or < <file> to read a value from another file. -d deletes one dotted path.
This module intentionally implements the common configuration subset used on shared hosting. Advanced format features should be edited textually with edit or code rather than silently reinterpreted.
This is not a general Nginx, Apache or all-purpose .env parser. Advanced directives and quoting may not be understood. Repeated keys and sections are rejected; comments and original layout are lost on rewrite. Prefer
Run the prepared examples directly on the page. Their results are prebuilt and shown in the browser; no terminal command is executed on the server.
Install the current compatible version. Choose Base for the complete feature set or Minimum for the reduced package; use upgrade to update a module that is already installed.
Base and Minimum are two packages of the same current module release, not separate command versions.
Install the complete package with local command reference and every published mode.
install confInstall the reduced package. Local reference is omitted;
install conf -mInstall exactly this published version.
install conf -v 1.1.6Ask upgrade to check compatibility and replace the installed block only when needed.
upgrade confRemove the extension block while leaving the core and unrelated modules intact.
install conf -uExamples are copyable command lines, not actions executed by this website. Review paths, permissions and destructive flags before running them on a real project.
cd \sandbox\config | conf app.confapplication shop
production true
database.host localhost
database.port 3306cd \sandbox\config | app.confapplication shop
production true
database.host localhost
database.port 3306conf config/app.conf database.hostlocalhostconf config/app.conf -f "database.*" -kdatabase.host localhost
database.port 3306conf config/app.conf -f "shop" -vapplication shopconf config/app.conf -f "production"production trueconf config/app.conf -w database.port : 3307database.port 3307conf config/app.conf -w application < config/plain-value.txtapplication demo-siteconf config/app.conf -d database.portapplication shop
production true
database.host localhostconf config/app.conf -cValid configurationconf dump config/app.confapplication=shop
production=true
[database]
host=localhost
port=3306
conf config/app.conf missing.keyPath not foundconf config/app.conf -w database.extra < config/value.jsonNested configuration sections are not supportedconf config/duplicate.conf -cDuplicate configuration keyconf config/missing.confFile not foundconf config/app.conf -w database.portValue required after : or sandbox/config/app.confThe example uses a file or directory from the protected /sandbox/ documentation workspace.
# common key/value configuration
application=shop
production=true
[database]
host=localhost
port=3306
Current stable release of