Skip to main content

init

create a new profile file in the current directory. the command prompts for required fields and writes the file.

usage​

npx declared-md init <kind>

where <kind> is one of:

  • whoami -- individual identity
  • whois -- organization identity
  • whatis -- project identity

examples​

create a personal profile:

npx declared-md init whoami

create an organization profile:

npx declared-md init whois

create a project profile:

npx declared-md init whatis

interactive prompts​

whoami​

the init prompts for:

  • name -- your display name
  • handle -- your URL slug (lowercase, alphanumeric, hyphens only)
  • GitHub username (optional) -- if provided, prefills name, location, and links from your public GitHub profile

whois​

prompts for:

  • name -- organization name
  • handle -- URL slug
  • kind_of_org -- company, nonprofit, community, collective, gov, or educational

whatis​

prompts for:

  • name -- project name
  • handle -- URL slug
  • kind_of_project -- library, framework, application, cli, service, protocol, dataset, or documentation
  • repo URL -- canonical GitHub repository URL

output​

the command writes a whoami.md, whois.md, or whatis.md file in the current directory.

the generated file has all required fields filled in and common optional fields commented out as examples. edit the file to add your actual content.

next step​

after running init:

  1. open the generated file and fill in the optional fields
  2. validate with npx declared-md validate
  3. preview with npx declared-md preview
  4. commit and push to the canonical location